Functions to retrieve information from the listed devices.
Before opening a device, device specific information can be retrieved. This information can help opening the required device, when multiple devices are available in the list.
Methods to identify the required device
Three different methods to identify a device are available:
|
| Combined devices |
| Functions to retrieve information from the individual devices in combined devices.
|
|
|
bool8_t | LstGetDeviceCanOpen (uint32_t dwIdKind, uint32_t dwId, uint32_t dwDeviceType) |
| Check whether the listed device can be opened. More...
|
|
uint32_t | LstGetDeviceProductId (uint32_t dwIdKind, uint32_t dwId) |
| Get the product id of the listed device. More...
|
|
uint32_t | LstGetDeviceName (uint32_t dwIdKind, uint32_t dwId, char *pBuffer, uint32_t dwBufferLength) |
| Get the full name of the listed device. More...
|
|
uint32_t | LstGetDeviceNameShort (uint32_t dwIdKind, uint32_t dwId, char *pBuffer, uint32_t dwBufferLength) |
| Get the short name of the listed device. More...
|
|
uint32_t | LstDevGetNameShortest (uint32_t dwIdKind, uint32_t dwId, char *pBuffer, uint32_t dwBufferLength) |
| Get the short name of the listed device wihout model postfix. More...
|
|
TpVersion_t | LstDevGetDriverVersion (uint32_t dwIdKind, uint32_t dwId) |
| Get the version number of the driver currently used by the listed device. More...
|
|
TpVersion_t | LstDevGetRecommendedDriverVersion (uint32_t dwIdKind, uint32_t dwId) |
| Get the version number of the recommended driver for the listed device. More...
|
|
TpVersion_t | LstDevGetFirmwareVersion (uint32_t dwIdKind, uint32_t dwId) |
| Get the version number of the firmware currently used by the listed device. More...
|
|
TpDate_t | LstDevGetCalibrationDate (uint32_t dwIdKind, uint32_t dwId) |
| Get the calibration date of the listed device. More...
|
|
uint32_t | LstGetDeviceSerialNumber (uint32_t dwIdKind, uint32_t dwId) |
| Get the serial number of the listed device. More...
|
|
uint32_t | LstGetDeviceTypes (uint32_t dwIdKind, uint32_t dwId) |
| Get the device types of the listed device. More...
|
|
bool8_t LstGetDeviceCanOpen |
( |
uint32_t |
dwIdKind, |
|
|
uint32_t |
dwId, |
|
|
uint32_t |
dwDeviceType |
|
) |
| |
Check whether the listed device can be opened.
- Parameters
-
dwIdKind | An id kind. |
dwId | A device index, Device ID or serial number identifying the device to check, as specified by dwIdKind . |
dwDeviceType | A device type. |
- Returns
- BOOL8_TRUE if the device can be opened or BOOL8_FALSE if not.
- Status values
-
- Since
- 0.4.0
uint32_t LstGetDeviceProductId |
( |
uint32_t |
dwIdKind, |
|
|
uint32_t |
dwId |
|
) |
| |
Get the product id of the listed device.
- Parameters
-
dwIdKind | An id kind. |
dwId | A device index, Device ID or serial number identifying the device to check, as specified by dwIdKind . |
- Returns
- The product id of the listed device.
- Status values
-
- Since
- 0.4.0
uint32_t LstGetDeviceName |
( |
uint32_t |
dwIdKind, |
|
|
uint32_t |
dwId, |
|
|
char * |
pBuffer, |
|
|
uint32_t |
dwBufferLength |
|
) |
| |
Get the full name of the listed device.
E.g. Handyscope HS5-530XMS
- Parameters
-
dwIdKind | An id kind. |
dwId | A device index, Device ID or serial number identifying the device to check, as specified by dwIdKind . |
pBuffer | A pointer to a buffer for the name. |
dwBufferLength | The length of the buffer, in bytes. |
- Returns
- The length of the name in bytes, excluding terminating zero.
- Status values
-
- See also
- LstGetDeviceNameShort
-
LstDevGetNameShortest
- Example
char* sName = malloc( sizeof( char ) * dwLength );
printf( "LstGetDeviceName = %s\n" , sName );
free( sName );
- Since
- 0.4.0
uint32_t LstGetDeviceNameShort |
( |
uint32_t |
dwIdKind, |
|
|
uint32_t |
dwId, |
|
|
char * |
pBuffer, |
|
|
uint32_t |
dwBufferLength |
|
) |
| |
Get the short name of the listed device.
E.g. HS5-530XMS
- Parameters
-
dwIdKind | An id kind. |
dwId | A device index, Device ID or serial number identifying the device to check, as specified by dwIdKind . |
pBuffer | A pointer to a buffer for the name. |
dwBufferLength | The length of the buffer, in bytes. |
- Returns
- The length of the name in bytes, excluding terminating zero.
- Status values
-
- See also
- LstGetDeviceName
-
LstDevGetNameShortest
- Example
char* sNameShort = malloc( sizeof( char ) * dwLength );
printf( "LstGetDeviceNameShort = %s\n" , sNameShort );
free( sNameShort );
- Since
- 0.4.0
uint32_t LstDevGetNameShortest |
( |
uint32_t |
dwIdKind, |
|
|
uint32_t |
dwId, |
|
|
char * |
pBuffer, |
|
|
uint32_t |
dwBufferLength |
|
) |
| |
Get the short name of the listed device wihout model postfix.
E.g. HS5
- Parameters
-
dwIdKind | An id kind. |
dwId | A device index, Device ID or serial number identifying the device to check, as specified by dwIdKind . |
pBuffer | A pointer to a buffer for the name. |
dwBufferLength | The length of the buffer, in bytes. |
- Returns
- The length of the name in bytes, excluding terminating zero.
- Status values
-
- See also
- LstGetDeviceName
-
LstGetDeviceNameShort
- Example
char* sNameShortest = malloc( sizeof( char ) * dwLength );
printf( "LstDevGetNameShortest = %s\n" , sNameShortest );
free( sNameShortest );
- Since
- 0.4.4
TpVersion_t LstDevGetDriverVersion |
( |
uint32_t |
dwIdKind, |
|
|
uint32_t |
dwId |
|
) |
| |
Get the version number of the driver currently used by the listed device.
- Parameters
-
dwIdKind | An id kind. |
dwId | A device index, Device ID or serial number identifying the device to check, as specified by dwIdKind . |
- Returns
- The version number of the driver currently used by the listed device, or zero if no driver version is available.
- Status values
-
- Since
- 0.4.1
TpVersion_t LstDevGetRecommendedDriverVersion |
( |
uint32_t |
dwIdKind, |
|
|
uint32_t |
dwId |
|
) |
| |
Get the version number of the recommended driver for the listed device.
- Parameters
-
dwIdKind | An id kind. |
dwId | A device index, Device ID or serial number identifying the device to check, as specified by dwIdKind . |
- Returns
- The version number of the recommended driver for the listed device, or zero if no driver version is available.
- Status values
-
- Since
- 0.4.3
TpVersion_t LstDevGetFirmwareVersion |
( |
uint32_t |
dwIdKind, |
|
|
uint32_t |
dwId |
|
) |
| |
Get the version number of the firmware currently used by the listed device.
- Parameters
-
dwIdKind | An id kind. |
dwId | A device index, Device ID or serial number identifying the device to check, as specified by dwIdKind . |
- Returns
- The version number of the firmware currently used firmware by the listed device, or zero if no firmware version is available.
- Status values
-
- Since
- 0.4.1
TpDate_t LstDevGetCalibrationDate |
( |
uint32_t |
dwIdKind, |
|
|
uint32_t |
dwId |
|
) |
| |
Get the calibration date of the listed device.
- Parameters
-
dwIdKind | An id kind. |
dwId | A device index, Device ID or serial number identifying the device to check, as specified by dwIdKind . |
- Returns
- The calibration date of the listed device, or zero if no calibration date is available.
- Status values
-
- Example
printf( "LstDevGetCalibrationDate = %u-%u-%u\n" , wYear , byMonth , byDay );
- Since
- 0.4.1
uint32_t LstGetDeviceSerialNumber |
( |
uint32_t |
dwIdKind, |
|
|
uint32_t |
dwId |
|
) |
| |
Get the serial number of the listed device.
- Parameters
-
dwIdKind | An id kind. |
dwId | A device index, Device ID or serial number identifying the device to check, as specified by dwIdKind . |
- Returns
- The serial number of the listed device.
- Status values
-
- Since
- 0.4.0
uint32_t LstGetDeviceTypes |
( |
uint32_t |
dwIdKind, |
|
|
uint32_t |
dwId |
|
) |
| |
Get the device types of the listed device.
- Parameters
-
dwIdKind | An id kind. |
dwId | A device index, Device ID or serial number identifying the device to check, as specified by dwIdKind . |
- Returns
- OR-ed mask of device types.
- Status values
-
- Example
printf( "DEVICETYPE_OSCILLOSCOPE\n" );
printf( "DEVICETYPE_GENERATOR\n" );
printf( "DEVICETYPE_I2CHOST\n" );
- Since
- 0.4.0