LibTiePie
0.9.12
Library for interfacing TiePie engineering instruments
|
Functions to retrieve information from the individual devices in combined devices.
To identify a contained device in a combined device, the combined device must be adressed and the also the contained device in it. Three different methods to identify a contained device in a combined are available:
Functions | |
uint32_t | LstDevGetContainedSerialNumbers (uint32_t dwIdKind, uint32_t dwId, uint32_t *pBuffer, uint32_t dwBufferLength) |
Get the serial numbers of the individual devices contained in a combined device. More... | |
uint32_t | LstCbDevGetProductId (uint32_t dwIdKind, uint32_t dwId, uint32_t dwContainedDeviceSerialNumber) |
Get the product id of a device contained in a combined device. More... | |
uint32_t | LstCbDevGetName (uint32_t dwIdKind, uint32_t dwId, uint32_t dwContainedDeviceSerialNumber, char *pBuffer, uint32_t dwBufferLength) |
Get the full name of a device contained in a combined device. More... | |
uint32_t | LstCbDevGetNameShort (uint32_t dwIdKind, uint32_t dwId, uint32_t dwContainedDeviceSerialNumber, char *pBuffer, uint32_t dwBufferLength) |
Get the short name of a device contained in a combined device. More... | |
uint32_t | LstCbDevGetNameShortest (uint32_t dwIdKind, uint32_t dwId, uint32_t dwContainedDeviceSerialNumber, char *pBuffer, uint32_t dwBufferLength) |
Get the short name without model postfix of a device contained in a combined device. More... | |
TpVersion_t | LstCbDevGetDriverVersion (uint32_t dwIdKind, uint32_t dwId, uint32_t dwContainedDeviceSerialNumber) |
Get the driver version of a device contained in a combined device. More... | |
TpVersion_t | LstCbDevGetFirmwareVersion (uint32_t dwIdKind, uint32_t dwId, uint32_t dwContainedDeviceSerialNumber) |
Get the firmware version of a device contained in a combined device. More... | |
TpDate_t | LstCbDevGetCalibrationDate (uint32_t dwIdKind, uint32_t dwId, uint32_t dwContainedDeviceSerialNumber) |
Get the calibration date of a device contained in a combined device. More... | |
uint16_t | LstCbScpGetChannelCount (uint32_t dwIdKind, uint32_t dwId, uint32_t dwContainedDeviceSerialNumber) |
Get the channel count of an oscilloscope contained in a combined oscilloscope. More... | |
uint32_t LstDevGetContainedSerialNumbers | ( | uint32_t | dwIdKind, |
uint32_t | dwId, | ||
uint32_t * | pBuffer, | ||
uint32_t | dwBufferLength | ||
) |
Get the serial numbers of the individual devices contained in a combined device.
[in] | dwIdKind | An id kind. |
[in] | dwId | A device index, Product ID or serial number identifying the combined device to check, as specified by dwIdKind . |
[out] | pBuffer | A pointer to a buffer for the serial numbers. |
[in] | dwBufferLength | The length of the buffer, in bytes. |
INVALID_VALUE | The value of dwIdKind is invalid. |
INVALID_DEVICE_INDEX | The device index is invalid, must be < LstGetCount(). |
INVALID_PRODUCT_ID | There is no combined device with the requested product ID. |
INVALID_DEVICE_SERIALNUMBER | There is no combined device with the requested serial number. |
NOT_SUPPORTED | The indicated device is not a combined device. |
LIBRARY_NOT_INITIALIZED | The library is not initialized, see LibInit(). |
SUCCESS | The function executed successfully. |
uint32_t LstCbDevGetProductId | ( | uint32_t | dwIdKind, |
uint32_t | dwId, | ||
uint32_t | dwContainedDeviceSerialNumber | ||
) |
Get the product id of a device contained in a combined device.
[in] | dwIdKind | An id kind. |
[in] | dwId | A device index, Product ID or serial number identifying the combined device to check, as specified by dwIdKind . |
[in] | dwContainedDeviceSerialNumber | The serial number identifying the contained device inside the combined device. |
INVALID_VALUE | The value of dwIdKind is invalid. |
INVALID_DEVICE_INDEX | The device index is invalid, must be < LstGetCount(). |
INVALID_PRODUCT_ID | There is no combined device with the requested product ID. |
INVALID_DEVICE_SERIALNUMBER | There is no combined device with the requested serial number. |
NOT_SUPPORTED | The indicated device is not a combined device or the contained device does not support reading a product id. |
INVALID_CONTAINED_DEVICE_SERIALNUMBER | There is no contained device with the requested serial number in de combined device. |
LIBRARY_NOT_INITIALIZED | The library is not initialized, see LibInit(). |
SUCCESS | The function executed successfully. |
uint32_t LstCbDevGetName | ( | uint32_t | dwIdKind, |
uint32_t | dwId, | ||
uint32_t | dwContainedDeviceSerialNumber, | ||
char * | pBuffer, | ||
uint32_t | dwBufferLength | ||
) |
Get the full name of a device contained in a combined device.
E.g. Handyscope HS5-530XMS
[in] | dwIdKind | An id kind. |
[in] | dwId | A device index, Product ID or serial number identifying the combined device to check, as specified by dwIdKind . |
[in] | dwContainedDeviceSerialNumber | The serial number identifying the contained device inside the combined device. |
[out] | pBuffer | A pointer to a buffer for the name. |
[in] | dwBufferLength | The length of the buffer, in bytes. |
INVALID_VALUE | The value of dwIdKind is invalid. |
INVALID_DEVICE_INDEX | The device index is invalid, must be < LstGetCount(). |
INVALID_PRODUCT_ID | There is no combined device with the requested product ID. |
INVALID_DEVICE_SERIALNUMBER | There is no combined device with the requested serial number. |
NOT_SUPPORTED | The indicated device is not a combined device or the contained device does not support reading a name. |
INVALID_CONTAINED_DEVICE_SERIALNUMBER | There is no contained device with the requested serial number in de combined device. |
LIBRARY_NOT_INITIALIZED | The library is not initialized, see LibInit(). |
SUCCESS | The function executed successfully. |
uint32_t LstCbDevGetNameShort | ( | uint32_t | dwIdKind, |
uint32_t | dwId, | ||
uint32_t | dwContainedDeviceSerialNumber, | ||
char * | pBuffer, | ||
uint32_t | dwBufferLength | ||
) |
Get the short name of a device contained in a combined device.
E.g. HS5-530XMS
[in] | dwIdKind | An id kind. |
[in] | dwId | A device index, Product ID or serial number identifying the combined device to check, as specified by dwIdKind . |
[in] | dwContainedDeviceSerialNumber | The serial number identifying the contained device inside the combined device. |
[out] | pBuffer | A pointer to a buffer for the name. |
[in] | dwBufferLength | The length of the buffer, in bytes. |
INVALID_VALUE | The value of dwIdKind is invalid. |
INVALID_DEVICE_INDEX | The device index is invalid, must be < LstGetCount(). |
INVALID_PRODUCT_ID | There is no combined device with the requested product ID. |
INVALID_DEVICE_SERIALNUMBER | There is no combined device with the requested serial number. |
NOT_SUPPORTED | The indicated device is not a combined device or the contained device does not support reading a name. |
INVALID_CONTAINED_DEVICE_SERIALNUMBER | There is no contained device with the requested serial number in de combined device. |
LIBRARY_NOT_INITIALIZED | The library is not initialized, see LibInit(). |
SUCCESS | The function executed successfully. |
uint32_t LstCbDevGetNameShortest | ( | uint32_t | dwIdKind, |
uint32_t | dwId, | ||
uint32_t | dwContainedDeviceSerialNumber, | ||
char * | pBuffer, | ||
uint32_t | dwBufferLength | ||
) |
Get the short name without model postfix of a device contained in a combined device.
E.g. HS5
[in] | dwIdKind | An id kind. |
[in] | dwId | A device index, Product ID or serial number identifying the combined device to check, as specified by dwIdKind . |
[in] | dwContainedDeviceSerialNumber | The serial number identifying the contained device inside the combined device. |
[out] | pBuffer | A pointer to a buffer for the name. |
[in] | dwBufferLength | The length of the buffer, in bytes. |
INVALID_VALUE | The value of dwIdKind is invalid. |
INVALID_DEVICE_INDEX | The device index is invalid, must be < LstGetCount(). |
INVALID_PRODUCT_ID | There is no combined device with the requested product ID. |
INVALID_DEVICE_SERIALNUMBER | There is no combined device with the requested serial number. |
NOT_SUPPORTED | The indicated device is not a combined device or the contained device does not support reading a name. |
INVALID_CONTAINED_DEVICE_SERIALNUMBER | There is no contained device with the requested serial number in de combined device. |
LIBRARY_NOT_INITIALIZED | The library is not initialized, see LibInit(). |
SUCCESS | The function executed successfully. |
TpVersion_t LstCbDevGetDriverVersion | ( | uint32_t | dwIdKind, |
uint32_t | dwId, | ||
uint32_t | dwContainedDeviceSerialNumber | ||
) |
Get the driver version of a device contained in a combined device.
[in] | dwIdKind | An id kind. |
[in] | dwId | A device index, Product ID or serial number identifying the combined device to check, as specified by dwIdKind . |
[in] | dwContainedDeviceSerialNumber | The serial number identifying the contained device inside the combined device. |
INVALID_VALUE | The value of dwIdKind is invalid. |
INVALID_DEVICE_INDEX | The device index is invalid, must be < LstGetCount(). |
INVALID_PRODUCT_ID | There is no combined device with the requested product ID. |
INVALID_DEVICE_SERIALNUMBER | There is no combined device with the requested serial number. |
NOT_SUPPORTED | The indicated device is not a combined device or the contained device does not support reading a driver version or does not require a driver. |
INVALID_CONTAINED_DEVICE_SERIALNUMBER | There is no contained device with the requested serial number in de combined device. |
LIBRARY_NOT_INITIALIZED | The library is not initialized, see LibInit(). |
SUCCESS | The function executed successfully. |
TpVersion_t LstCbDevGetFirmwareVersion | ( | uint32_t | dwIdKind, |
uint32_t | dwId, | ||
uint32_t | dwContainedDeviceSerialNumber | ||
) |
Get the firmware version of a device contained in a combined device.
[in] | dwIdKind | An id kind. |
[in] | dwId | A device index, Product ID or serial number identifying the combined device to check, as specified by dwIdKind . |
[in] | dwContainedDeviceSerialNumber | The serial number identifying the contained device inside the combined device. |
INVALID_VALUE | The value of dwIdKind is invalid. |
INVALID_DEVICE_INDEX | The device index is invalid, must be < LstGetCount(). |
INVALID_PRODUCT_ID | There is no combined device with the requested product ID. |
INVALID_DEVICE_SERIALNUMBER | There is no combined device with the requested serial number. |
NOT_SUPPORTED | The indicated device is not a combined device or the contained device does not support reading a firmware version or does not require firmware. |
INVALID_CONTAINED_DEVICE_SERIALNUMBER | There is no contained device with the requested serial number in de combined device. |
LIBRARY_NOT_INITIALIZED | The library is not initialized, see LibInit(). |
SUCCESS | The function executed successfully. |
TpDate_t LstCbDevGetCalibrationDate | ( | uint32_t | dwIdKind, |
uint32_t | dwId, | ||
uint32_t | dwContainedDeviceSerialNumber | ||
) |
Get the calibration date of a device contained in a combined device.
[in] | dwIdKind | An id kind. |
[in] | dwId | A device index, Product ID or serial number identifying the combined device to check, as specified by dwIdKind . |
[in] | dwContainedDeviceSerialNumber | The serial number identifying the contained device inside the combined device. |
INVALID_VALUE | The value of dwIdKind is invalid. |
INVALID_DEVICE_INDEX | The device index is invalid, must be < LstGetCount(). |
INVALID_PRODUCT_ID | There is no combined device with the requested product ID. |
INVALID_DEVICE_SERIALNUMBER | There is no combined device with the requested serial number. |
NOT_SUPPORTED | The indicated device is not a combined device or the contained device does not have a calibration date. |
INVALID_CONTAINED_DEVICE_SERIALNUMBER | There is no contained device with the requested serial number in de combined device. |
LIBRARY_NOT_INITIALIZED | The library is not initialized, see LibInit(). |
SUCCESS | The function executed successfully. |
uint16_t LstCbScpGetChannelCount | ( | uint32_t | dwIdKind, |
uint32_t | dwId, | ||
uint32_t | dwContainedDeviceSerialNumber | ||
) |
Get the channel count of an oscilloscope contained in a combined oscilloscope.
[in] | dwIdKind | An id kind. |
[in] | dwId | A device index, Product ID or serial number identifying the combined oscilloscope to check, as specified by dwIdKind . |
[in] | dwContainedDeviceSerialNumber | The serial number identifying the contained oscilloscope inside the combined oscilloscope. |
INVALID_VALUE | The value of dwIdKind is invalid. |
INVALID_DEVICE_INDEX | The device index is invalid, must be < LstGetCount(). |
INVALID_PRODUCT_ID | There is no combined oscilloscope with the requested product ID. |
INVALID_DEVICE_SERIALNUMBER | There is no combined oscilloscope with the requested serial number. |
NOT_SUPPORTED | The indicated device is not a combined oscilloscope. |
INVALID_CONTAINED_DEVICE_SERIALNUMBER | There is no contained device with the requested serial number in de combined device. |
LIBRARY_NOT_INITIALIZED | The library is not initialized, see LibInit(). |
SUCCESS | The function executed successfully. |