LibTiePie  0.4.4
Library for interfacing TiePie engineering instruments
 All Files Functions Typedefs Macros Groups Pages
Status return codes

Macros

#define LIBTIEPIESTATUS_SUCCESS   0
 The last called function was executed successfully.
 
#define LIBTIEPIESTATUS_VALUE_CLIPPED   1
 One of the parameters of the last called function was outside the valid range and clipped to the closest limit.
 
#define LIBTIEPIESTATUS_VALUE_MODIFIED   2
 One of the parameters of the last called function was within the valid range but not available. The closest valid value is set.
 
#define LIBTIEPIESTATUS_UNSUCCESSFUL   -1
 An error occurred during execution of the last called function.
 
#define LIBTIEPIESTATUS_NOT_SUPPORTED   -2
 The requested functionality is not supported by the hardware.
 
#define LIBTIEPIESTATUS_INVALID_HANDLE   -3
 The handle to the device is invalid.
 
#define LIBTIEPIESTATUS_INVALID_VALUE   -4
 The requested value is not valid.
 
#define LIBTIEPIESTATUS_INVALID_CHANNEL   -5
 The requested channel is not valid.
 
#define LIBTIEPIESTATUS_INVALID_TRIGGER_SOURCE   -6
 The requested trigger source is not valid.
 
#define LIBTIEPIESTATUS_INVALID_DEVICE_TYPE   -7
 The requested device type is not valid.
 
#define LIBTIEPIESTATUS_INVALID_DEVICE_INDEX   -8
 The requested device index is not valid.
 
#define LIBTIEPIESTATUS_INVALID_DEVICE_ID   -9
 The requested device ID is not valid.
 
#define LIBTIEPIESTATUS_INVALID_DEVICE_SERIALNUMBER   -10
 The requested device serial number is not available.
 
#define LIBTIEPIESTATUS_DEVICE_GONE   -11
 The device indicated by the device handle is no longer available.
 
#define LIBTIEPIESTATUS_INTERNAL_ADDRESS   -12
 The requested I2C address is an internally used address in the device.
 
#define LIBTIEPIESTATUS_NOT_CONTROLLABLE   -13
 The generator is currently not controllable, see GenIsControllable.
 
#define LIBTIEPIESTATUS_BIT_ERROR   -14
 The requested I2C operation generated a bit error.
 
#define LIBTIEPIESTATUS_NO_ACKNOWLEDGE   -15
 The requested I2C operation generated "No acknowledge".
 
#define LIBTIEPIESTATUS_INVALID_CONTAINED_DEVICE_SERIALNUMBER   -16
 A device with the requested serial number is not available in the combined instrument, see LstDevGetContainedSerialNumbers.
 
#define LIBTIEPIESTATUS_INVALID_INPUT   -17
 The requested trigger input is not valid.
 
#define LIBTIEPIESTATUS_INVALID_OUTPUT   -18
 The requested trigger output is not valid.
 
#define LIBTIEPIESTATUS_INVALID_DRIVER   -19
 The currently installed driver is not supported, see LstDevGetRecommendedDriverVersion(). (Windows only)
 
#define LIBTIEPIESTATUS_NOT_AVAILABLE   -20
 The requested functionality is currently not available.
 

Detailed Description

These codes show the status of the last called LibTiePie function.

0 means ok
<0 means error
>0 means ok, but with a side effect

Macro Definition Documentation

#define LIBTIEPIESTATUS_SUCCESS   0

The last called function was executed successfully.

Definition at line 1138 of file libtiepie.h.

#define LIBTIEPIESTATUS_VALUE_CLIPPED   1

One of the parameters of the last called function was outside the valid range and clipped to the closest limit.

Definition at line 1139 of file libtiepie.h.

#define LIBTIEPIESTATUS_VALUE_MODIFIED   2

One of the parameters of the last called function was within the valid range but not available. The closest valid value is set.

Definition at line 1140 of file libtiepie.h.

#define LIBTIEPIESTATUS_UNSUCCESSFUL   -1

An error occurred during execution of the last called function.

Definition at line 1141 of file libtiepie.h.

#define LIBTIEPIESTATUS_NOT_SUPPORTED   -2

The requested functionality is not supported by the hardware.

Definition at line 1142 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_HANDLE   -3

The handle to the device is invalid.

Definition at line 1143 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_VALUE   -4

The requested value is not valid.

Definition at line 1144 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_CHANNEL   -5

The requested channel is not valid.

Definition at line 1145 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_TRIGGER_SOURCE   -6

The requested trigger source is not valid.

Definition at line 1146 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_DEVICE_TYPE   -7

The requested device type is not valid.

Definition at line 1147 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_DEVICE_INDEX   -8

The requested device index is not valid.

Definition at line 1148 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_DEVICE_ID   -9

The requested device ID is not valid.

Definition at line 1149 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_DEVICE_SERIALNUMBER   -10

The requested device serial number is not available.

Definition at line 1150 of file libtiepie.h.

#define LIBTIEPIESTATUS_DEVICE_GONE   -11

The device indicated by the device handle is no longer available.

Definition at line 1151 of file libtiepie.h.

#define LIBTIEPIESTATUS_INTERNAL_ADDRESS   -12

The requested I2C address is an internally used address in the device.

Definition at line 1152 of file libtiepie.h.

#define LIBTIEPIESTATUS_NOT_CONTROLLABLE   -13

The generator is currently not controllable, see GenIsControllable.

Definition at line 1153 of file libtiepie.h.

#define LIBTIEPIESTATUS_BIT_ERROR   -14

The requested I2C operation generated a bit error.

Definition at line 1154 of file libtiepie.h.

#define LIBTIEPIESTATUS_NO_ACKNOWLEDGE   -15

The requested I2C operation generated "No acknowledge".

Definition at line 1155 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_CONTAINED_DEVICE_SERIALNUMBER   -16

A device with the requested serial number is not available in the combined instrument, see LstDevGetContainedSerialNumbers.

Definition at line 1156 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_INPUT   -17

The requested trigger input is not valid.

Definition at line 1157 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_OUTPUT   -18

The requested trigger output is not valid.

Definition at line 1158 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_DRIVER   -19

The currently installed driver is not supported, see LstDevGetRecommendedDriverVersion(). (Windows only)

Definition at line 1159 of file libtiepie.h.

#define LIBTIEPIESTATUS_NOT_AVAILABLE   -20

The requested functionality is currently not available.

Definition at line 1160 of file libtiepie.h.