libtiepie-hw
1.2.0
|
Functions to retrieve information from the listed devices. More...
Modules | |
Combined devices | |
Functions to retrieve information from the individual devices in combined devices. | |
Functions | |
TIEPIE_HW_API tiepie_hw_bool | tiepie_hw_devicelistitem_is_demo (tiepie_hw_handle handle) |
Check whether the listed device is a demo device. More... | |
TIEPIE_HW_API tiepie_hw_bool | tiepie_hw_devicelistitem_can_open (tiepie_hw_handle handle, uint32_t device_type) |
Check whether the listed device can be opened. More... | |
TIEPIE_HW_API uint32_t | tiepie_hw_devicelistitem_opened_by (tiepie_hw_handle handle, uint32_t device_type, char *buffer, uint32_t length) |
See who is using the device. More... | |
TIEPIE_HW_API tiepie_hw_productid | tiepie_hw_devicelistitem_get_product_id (tiepie_hw_handle handle) |
Get the product id of the listed device. More... | |
TIEPIE_HW_API uint32_t | tiepie_hw_devicelistitem_get_name (tiepie_hw_handle handle, char *buffer, uint32_t length) |
Get the full name of the listed device. More... | |
TIEPIE_HW_API uint32_t | tiepie_hw_devicelistitem_get_name_short (tiepie_hw_handle handle, char *buffer, uint32_t length) |
Get the short name of the listed device. More... | |
TIEPIE_HW_API uint32_t | tiepie_hw_devicelistitem_get_name_shortest (tiepie_hw_handle handle, char *buffer, uint32_t length) |
Get the short name of the listed device wihout model postfix. More... | |
TIEPIE_HW_API tiepie_hw_date | tiepie_hw_devicelistitem_get_calibration_date (tiepie_hw_handle handle) |
Get the calibration date of the listed device. More... | |
TIEPIE_HW_API uint32_t | tiepie_hw_devicelistitem_get_serial_number (tiepie_hw_handle handle) |
Get the serial number of the listed device. More... | |
TIEPIE_HW_API uint32_t | tiepie_hw_devicelistitem_get_ip_address (tiepie_hw_handle handle, char *buffer, uint32_t length) |
Get the IP address of the listed device. More... | |
TIEPIE_HW_API uint16_t | tiepie_hw_devicelistitem_get_ip_port (tiepie_hw_handle handle) |
Get the IP port number of the listed device. More... | |
TIEPIE_HW_API tiepie_hw_bool | tiepie_hw_devicelistitem_has_server (tiepie_hw_handle handle) |
Check whether the listed device is connected to a server. More... | |
TIEPIE_HW_API tiepie_hw_handle | tiepie_hw_devicelistitem_get_server (tiepie_hw_handle handle) |
Get the server handle of the server the listed device is connected to. More... | |
TIEPIE_HW_API uint32_t | tiepie_hw_devicelistitem_get_types (tiepie_hw_handle handle) |
Get the device types of the listed device. More... | |
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.
TIEPIE_HW_API tiepie_hw_bool tiepie_hw_devicelistitem_is_demo | ( | tiepie_hw_handle | handle | ) |
Check whether the listed device is a demo device.
[in] | handle | A handle identifying the object. |
TIEPIE_HW_STATUS_INVALID_VALUE | The value of id_kind is invalid. |
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED | |
TIEPIE_HW_STATUS_SUCCESS |
TIEPIE_HW_API tiepie_hw_bool tiepie_hw_devicelistitem_can_open | ( | tiepie_hw_handle | handle, |
uint32_t | device_type | ||
) |
Check whether the listed device can be opened.
[in] | handle | A handle identifying the object. |
[in] | device_type | A device type. |
TIEPIE_HW_API uint32_t tiepie_hw_devicelistitem_opened_by | ( | tiepie_hw_handle | handle, |
uint32_t | device_type, | ||
char * | buffer, | ||
uint32_t | length | ||
) |
See who is using the device.
[in] | handle | A handle identifying the object. |
[in] | device_type | A device type. |
[out] | buffer | A pointer to a buffer for the status. |
[in] | length | The length of the buffer, in bytes. |
TIEPIE_HW_STATUS_INVALID_DEVICE_TYPE | |
TIEPIE_HW_STATUS_INVALID_VALUE | The value of Id_kind is invalid. |
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED | |
TIEPIE_HW_STATUS_INVALID_HANDLE | |
TIEPIE_HW_STATUS_SUCCESS |
TIEPIE_HW_API tiepie_hw_productid tiepie_hw_devicelistitem_get_product_id | ( | tiepie_hw_handle | handle | ) |
Get the product id of the listed device.
[in] | handle | A handle identifying the object. |
TIEPIE_HW_STATUS_NOT_SUPPORTED | The indicated device does not support reading a product id. |
TIEPIE_HW_STATUS_INVALID_VALUE | The value of Id_kind is invalid. |
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED | |
TIEPIE_HW_STATUS_SUCCESS |
TIEPIE_HW_API uint32_t tiepie_hw_devicelistitem_get_name | ( | tiepie_hw_handle | handle, |
char * | buffer, | ||
uint32_t | length | ||
) |
Get the full name of the listed device.
E.g. Handyscope HS5-530XMS
[in] | handle | A handle identifying the object. |
[out] | buffer | A pointer to a buffer for the name. |
[in] | length | The length of the buffer, in bytes. |
TIEPIE_HW_STATUS_NOT_SUPPORTED | The indicated device does not support reading a name. |
TIEPIE_HW_STATUS_INVALID_VALUE | The value of Id_kind is invalid. |
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED | |
TIEPIE_HW_STATUS_SUCCESS |
TIEPIE_HW_API uint32_t tiepie_hw_devicelistitem_get_name_short | ( | tiepie_hw_handle | handle, |
char * | buffer, | ||
uint32_t | length | ||
) |
Get the short name of the listed device.
E.g. HS5-530XMS
[in] | handle | A handle identifying the object. |
[out] | buffer | A pointer to a buffer for the name. |
[in] | length | The length of the buffer, in bytes. |
TIEPIE_HW_STATUS_NOT_SUPPORTED | The indicated device does not support reading a name. |
TIEPIE_HW_STATUS_INVALID_VALUE | The value of Id_kind is invalid. |
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED | |
TIEPIE_HW_STATUS_SUCCESS |
TIEPIE_HW_API uint32_t tiepie_hw_devicelistitem_get_name_shortest | ( | tiepie_hw_handle | handle, |
char * | buffer, | ||
uint32_t | length | ||
) |
Get the short name of the listed device wihout model postfix.
E.g. HS5
[in] | handle | A handle identifying the object. |
[out] | buffer | A pointer to a buffer for the name. |
[in] | length | The length of the buffer, in bytes. |
TIEPIE_HW_STATUS_NOT_SUPPORTED | The indicated device does not support reading a name. |
TIEPIE_HW_STATUS_INVALID_VALUE | The value of Id_kind is invalid. |
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED | |
TIEPIE_HW_STATUS_SUCCESS |
TIEPIE_HW_API tiepie_hw_date tiepie_hw_devicelistitem_get_calibration_date | ( | tiepie_hw_handle | handle | ) |
Get the calibration date of the listed device.
[in] | handle | A handle identifying the object. |
TIEPIE_HW_STATUS_NOT_SUPPORTED | The indicated device does not have a calibration date. |
TIEPIE_HW_STATUS_INVALID_VALUE | The value of Id_kind is invalid. |
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED | |
TIEPIE_HW_STATUS_SUCCESS |
TIEPIE_HW_API uint32_t tiepie_hw_devicelistitem_get_serial_number | ( | tiepie_hw_handle | handle | ) |
Get the serial number of the listed device.
[in] | handle | A handle identifying the object. |
TIEPIE_HW_STATUS_INITIALIZATION_FAILED | |
TIEPIE_HW_STATUS_INVALID_EEPROM | |
TIEPIE_HW_STATUS_INVALID_FIRMWARE | |
TIEPIE_HW_STATUS_NOT_SUPPORTED | The indicated device does not support reading a serial number. |
TIEPIE_HW_STATUS_INVALID_VALUE | The value of Id_kind is invalid. |
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED | |
TIEPIE_HW_STATUS_SUCCESS |
TIEPIE_HW_API uint32_t tiepie_hw_devicelistitem_get_ip_address | ( | tiepie_hw_handle | handle, |
char * | buffer, | ||
uint32_t | length | ||
) |
Get the IP address of the listed device.
[in] | handle | A handle identifying the object. |
[out] | buffer | A pointer to a buffer for the IP address. |
[in] | length | The length of the buffer, in bytes. |
TIEPIE_HW_STATUS_NOT_SUPPORTED | The indicated device is not a network device. |
TIEPIE_HW_STATUS_INVALID_VALUE | The value of Id_kind is invalid. |
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED | |
TIEPIE_HW_STATUS_SUCCESS |
TIEPIE_HW_API uint16_t tiepie_hw_devicelistitem_get_ip_port | ( | tiepie_hw_handle | handle | ) |
Get the IP port number of the listed device.
[in] | handle | A handle identifying the object. |
TIEPIE_HW_STATUS_NOT_SUPPORTED | The indicated device is not a network device. |
TIEPIE_HW_STATUS_INVALID_VALUE | The value of Id_kind is invalid. |
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED | |
TIEPIE_HW_STATUS_SUCCESS |
TIEPIE_HW_API tiepie_hw_bool tiepie_hw_devicelistitem_has_server | ( | tiepie_hw_handle | handle | ) |
Check whether the listed device is connected to a server.
[in] | handle | A handle identifying the object. |
TIEPIE_HW_API tiepie_hw_handle tiepie_hw_devicelistitem_get_server | ( | tiepie_hw_handle | handle | ) |
Get the server handle of the server the listed device is connected to.
[in] | handle | A handle identifying the object. |
TIEPIE_HW_API uint32_t tiepie_hw_devicelistitem_get_types | ( | tiepie_hw_handle | handle | ) |
Get the device types of the listed device.
[in] | handle | A handle identifying the object. |