LibTiePie  0.9.8
Library for interfacing TiePie engineering instruments
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 invalid. More...
 
#define LIBTIEPIESTATUS_INVALID_CHANNEL   -5
 The requested channel number is invalid. More...
 
#define LIBTIEPIESTATUS_INVALID_TRIGGER_SOURCE   -6
 The requested trigger source is invalid. 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_PRODUCT_ID   -9
 There is no device with the requested product ID. More...
 
#define LIBTIEPIESTATUS_INVALID_DEVICE_SERIALNUMBER   -10
 There is no device with the requested serial number. More...
 
#define LIBTIEPIESTATUS_OBJECT_GONE   -11
 The object indicated by the handle is no longer available. More...
 
#define LIBTIEPIESTATUS_DEVICE_GONE   LIBTIEPIESTATUS_OBJECT_GONE
 
#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 invalid. More...
 
#define LIBTIEPIESTATUS_INVALID_OUTPUT   -18
 The requested trigger output is invalid. 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 invalid. More...
 
#define LIBTIEPIESTATUS_INVALID_EEPROM   -23
 The instrument's EEPROM content is damaged, please contact TiePie engineering support. More...
 
#define LIBTIEPIESTATUS_INITIALIZATION_FAILED   -24
 The instrument's initialization failed, please contact TiePie engineering support. More...
 
#define LIBTIEPIESTATUS_LIBRARY_NOT_INITIALIZED   -25
 The library is not initialized, see LibInit(). More...
 
#define LIBTIEPIESTATUS_NO_TRIGGER_ENABLED   -26
 The current setup requires a trigger input to be enabled. More...
 
#define LIBTIEPIESTATUS_SYNCHRONIZATION_FAILED   -29
 XXX. More...
 
#define LIBTIEPIESTATUS_INVALID_HS56_COMBINED_DEVICE   -30
 At least one Handyscope HS6 DIFF must be located at the beginning or end of the CMI daisy chain. More...
 
#define LIBTIEPIESTATUS_MEASUREMENT_RUNNING   -31
 A measurement is already running. More...
 
#define LIBTIEPIESTATUS_INITIALIZATION_ERROR_10001   -10001
 The instrument's initialization failed (code: 10001), please contact TiePie engineering support. More...
 
#define LIBTIEPIESTATUS_INITIALIZATION_ERROR_10002   -10002
 The instrument's initialization failed (code: 10002), please contact TiePie engineering support. More...
 
#define LIBTIEPIESTATUS_INITIALIZATION_ERROR_10003   -10003
 The instrument's initialization failed (code: 10003), please contact TiePie engineering support. More...
 
#define LIBTIEPIESTATUS_INITIALIZATION_ERROR_10004   -10004
 The instrument's initialization failed (code: 10004), please contact TiePie engineering support. More...
 
#define LIBTIEPIESTATUS_INITIALIZATION_ERROR_10005   -10005
 The instrument's initialization failed (code: 10005), please contact TiePie engineering support. More...
 
#define LIBTIEPIESTATUS_INITIALIZATION_ERROR_10006   -10006
 The instrument's initialization failed (code: 10006), please contact TiePie engineering support. More...
 

Macro Definition Documentation

#define LIBTIEPIESTATUS_SUCCESS   0

The function executed successfully.

Definition at line 474 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 475 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 476 of file libtiepie.h.

#define LIBTIEPIESTATUS_UNSUCCESSFUL   -1

An error occurred during execution of the last called function.

Definition at line 477 of file libtiepie.h.

#define LIBTIEPIESTATUS_NOT_SUPPORTED   -2

The requested functionality is not supported by the hardware.

Definition at line 478 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_HANDLE   -3

The handle to the device is invalid.

Definition at line 479 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_VALUE   -4

The requested value is invalid.

Definition at line 480 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_CHANNEL   -5

The requested channel number is invalid.

Definition at line 481 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_TRIGGER_SOURCE   -6

The requested trigger source is invalid.

Definition at line 482 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_DEVICE_TYPE   -7

The device type is invalid.

Definition at line 483 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_DEVICE_INDEX   -8

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

Definition at line 484 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_PRODUCT_ID   -9

There is no device with the requested product ID.

Definition at line 485 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_DEVICE_SERIALNUMBER   -10

There is no device with the requested serial number.

Definition at line 486 of file libtiepie.h.

#define LIBTIEPIESTATUS_OBJECT_GONE   -11

The object indicated by the handle is no longer available.

Definition at line 487 of file libtiepie.h.

#define LIBTIEPIESTATUS_DEVICE_GONE   LIBTIEPIESTATUS_OBJECT_GONE
Deprecated:
Use: LIBTIEPIESTATUS_OBJECT_GONE

Definition at line 488 of file libtiepie.h.

#define LIBTIEPIESTATUS_INTERNAL_ADDRESS   -12

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

Definition at line 489 of file libtiepie.h.

#define LIBTIEPIESTATUS_NOT_CONTROLLABLE   -13

The generator is currently not controllable, see GenIsControllable.

Definition at line 490 of file libtiepie.h.

#define LIBTIEPIESTATUS_BIT_ERROR   -14

The requested I2C operation generated a bit error.

Definition at line 491 of file libtiepie.h.

#define LIBTIEPIESTATUS_NO_ACKNOWLEDGE   -15

The requested I2C operation generated "No acknowledge".

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

#define LIBTIEPIESTATUS_INVALID_INPUT   -17

The requested trigger input is invalid.

Definition at line 494 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_OUTPUT   -18

The requested trigger output is invalid.

Definition at line 495 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_DRIVER   -19

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

Definition at line 496 of file libtiepie.h.

#define LIBTIEPIESTATUS_NOT_AVAILABLE   -20

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

Definition at line 497 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_FIRMWARE   -21

The currently used firmware is not supported .

Definition at line 498 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_INDEX   -22

The requested index is invalid.

Definition at line 499 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_EEPROM   -23

The instrument's EEPROM content is damaged, please contact TiePie engineering support.

Definition at line 500 of file libtiepie.h.

#define LIBTIEPIESTATUS_INITIALIZATION_FAILED   -24

The instrument's initialization failed, please contact TiePie engineering support.

Definition at line 501 of file libtiepie.h.

#define LIBTIEPIESTATUS_LIBRARY_NOT_INITIALIZED   -25

The library is not initialized, see LibInit().

Definition at line 502 of file libtiepie.h.

#define LIBTIEPIESTATUS_NO_TRIGGER_ENABLED   -26

The current setup requires a trigger input to be enabled.

Definition at line 503 of file libtiepie.h.

#define LIBTIEPIESTATUS_SYNCHRONIZATION_FAILED   -29

XXX.

Definition at line 505 of file libtiepie.h.

#define LIBTIEPIESTATUS_INVALID_HS56_COMBINED_DEVICE   -30

At least one Handyscope HS6 DIFF must be located at the beginning or end of the CMI daisy chain.

Definition at line 506 of file libtiepie.h.

#define LIBTIEPIESTATUS_MEASUREMENT_RUNNING   -31

A measurement is already running.

Definition at line 507 of file libtiepie.h.

#define LIBTIEPIESTATUS_INITIALIZATION_ERROR_10001   -10001

The instrument's initialization failed (code: 10001), please contact TiePie engineering support.

Definition at line 509 of file libtiepie.h.

#define LIBTIEPIESTATUS_INITIALIZATION_ERROR_10002   -10002

The instrument's initialization failed (code: 10002), please contact TiePie engineering support.

Definition at line 510 of file libtiepie.h.

#define LIBTIEPIESTATUS_INITIALIZATION_ERROR_10003   -10003

The instrument's initialization failed (code: 10003), please contact TiePie engineering support.

Definition at line 511 of file libtiepie.h.

#define LIBTIEPIESTATUS_INITIALIZATION_ERROR_10004   -10004

The instrument's initialization failed (code: 10004), please contact TiePie engineering support.

Definition at line 512 of file libtiepie.h.

#define LIBTIEPIESTATUS_INITIALIZATION_ERROR_10005   -10005

The instrument's initialization failed (code: 10005), please contact TiePie engineering support.

Definition at line 513 of file libtiepie.h.

#define LIBTIEPIESTATUS_INITIALIZATION_ERROR_10006   -10006

The instrument's initialization failed (code: 10006), please contact TiePie engineering support.

Definition at line 514 of file libtiepie.h.