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

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

Macros

#define LIBTIEPIESTATUS_SUCCESS   0
 The function executed successfully. More...
 
#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. More...
 
#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. More...
 
#define LIBTIEPIESTATUS_UNSUCCESSFUL   -1
 An error occurred during execution of the last called function. More...
 
#define LIBTIEPIESTATUS_NOT_SUPPORTED   -2
 The requested functionality is not supported by the hardware. More...
 
#define LIBTIEPIESTATUS_INVALID_HANDLE   -3
 The handle to the device is invalid. More...
 
#define LIBTIEPIESTATUS_INVALID_VALUE   -4
 The requested value is not valid. More...
 
#define LIBTIEPIESTATUS_INVALID_CHANNEL   -5
 The requested channel number is not valid. More...
 
#define LIBTIEPIESTATUS_INVALID_TRIGGER_SOURCE   -6
 The requested trigger source is not valid. More...
 
#define LIBTIEPIESTATUS_INVALID_DEVICE_TYPE   -7
 The device type is invalid. More...
 
#define LIBTIEPIESTATUS_INVALID_DEVICE_INDEX   -8
 The device index is invalid, must be < LstGetCount(). More...
 
#define LIBTIEPIESTATUS_INVALID_DEVICE_ID   -9
 There is no device with the requested device ID. More...
 
#define LIBTIEPIESTATUS_INVALID_DEVICE_SERIALNUMBER   -10
 There is no device with the requested serial number. More...
 
#define LIBTIEPIESTATUS_DEVICE_GONE   -11
 The device indicated by the device handle is no longer available. More...
 
#define LIBTIEPIESTATUS_INTERNAL_ADDRESS   -12
 The requested I2C address is an internally used address in the device. More...
 
#define LIBTIEPIESTATUS_NOT_CONTROLLABLE   -13
 The generator is currently not controllable, see GenIsControllable. More...
 
#define LIBTIEPIESTATUS_BIT_ERROR   -14
 The requested I2C operation generated a bit error. More...
 
#define LIBTIEPIESTATUS_NO_ACKNOWLEDGE   -15
 The requested I2C operation generated "No acknowledge". More...
 
#define LIBTIEPIESTATUS_INVALID_CONTAINED_DEVICE_SERIALNUMBER   -16
 A device with the requested serial number is not available in the combined instrument, see LstDevGetContainedSerialNumbers. More...
 
#define LIBTIEPIESTATUS_INVALID_INPUT   -17
 The requested trigger input is not valid. More...
 
#define LIBTIEPIESTATUS_INVALID_OUTPUT   -18
 The requested trigger output is not valid. More...
 
#define LIBTIEPIESTATUS_INVALID_DRIVER   -19
 The currently installed driver is not supported, see LstDevGetRecommendedDriverVersion(). (Windows only) More...
 
#define LIBTIEPIESTATUS_NOT_AVAILABLE   -20
 With the current settings, the requested functionality is not available. More...
 
#define LIBTIEPIESTATUS_INVALID_FIRMWARE   -21
 The currently used firmware is not supported . More...
 
#define LIBTIEPIESTATUS_INVALID_INDEX   -22
 The requested index is not valid. More...
 

Macro Definition Documentation

#define LIBTIEPIESTATUS_SUCCESS   0

The function executed successfully.

Definition at line 1112 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 1113 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 1114 of file libtiepie.h.

#define LIBTIEPIESTATUS_UNSUCCESSFUL   -1

An error occurred during execution of the last called function.

Definition at line 1115 of file libtiepie.h.

#define LIBTIEPIESTATUS_NOT_SUPPORTED   -2

The requested functionality is not supported by the hardware.

Definition at line 1116 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_HANDLE   -3

The handle to the device is invalid.

Definition at line 1117 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_VALUE   -4

The requested value is not valid.

Definition at line 1118 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_CHANNEL   -5

The requested channel number is not valid.

Definition at line 1119 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_TRIGGER_SOURCE   -6

The requested trigger source is not valid.

Definition at line 1120 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_DEVICE_TYPE   -7

The device type is invalid.

Definition at line 1121 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_DEVICE_INDEX   -8

The device index is invalid, must be < LstGetCount().

Definition at line 1122 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_DEVICE_ID   -9

There is no device with the requested device ID.

Definition at line 1123 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_DEVICE_SERIALNUMBER   -10

There is no device with the requested serial number.

Definition at line 1124 of file libtiepie.h.

#define LIBTIEPIESTATUS_DEVICE_GONE   -11

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

Definition at line 1125 of file libtiepie.h.

#define LIBTIEPIESTATUS_INTERNAL_ADDRESS   -12

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

Definition at line 1126 of file libtiepie.h.

#define LIBTIEPIESTATUS_NOT_CONTROLLABLE   -13

The generator is currently not controllable, see GenIsControllable.

Definition at line 1127 of file libtiepie.h.

#define LIBTIEPIESTATUS_BIT_ERROR   -14

The requested I2C operation generated a bit error.

Definition at line 1128 of file libtiepie.h.

#define LIBTIEPIESTATUS_NO_ACKNOWLEDGE   -15

The requested I2C operation generated "No acknowledge".

Definition at line 1129 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 1130 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_INPUT   -17

The requested trigger input is not valid.

Definition at line 1131 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_OUTPUT   -18

The requested trigger output is not valid.

Definition at line 1132 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_DRIVER   -19

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

Definition at line 1133 of file libtiepie.h.

#define LIBTIEPIESTATUS_NOT_AVAILABLE   -20

With the current settings, the requested functionality is not available.

Definition at line 1134 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_FIRMWARE   -21

The currently used firmware is not supported .

Definition at line 1135 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_INDEX   -22

The requested index is not valid.

Definition at line 1136 of file libtiepie.h.