C API HF2 Only Functions¶
ziAPIUpdateDevices¶
ZIResult_enum ziAPIUpdateDevices(ZIConnection conn)
Search for the newly connected devices and update the tree.
This function forces the Data Server to search for newly connected devices and to connect to run them ziAPIListNodes
Parameters
Name | Type | Direction | Description |
---|---|---|---|
conn | ZIConnection | in | Pointer to ZIConnection |
Returns
- ZI_INFO_SUCCESS
- Other return codes may also be returned, for a detailed error message use ziAPIGetLastError.
ziAPIEchoDevice¶
ZIResult_enum ziAPIEchoDevice(ZIConnection conn, const char *deviceSerial)
Sends an echo command to a device and blocks until answer is received.
This is useful to flush all buffers between API and device to enforce that further code is only executed after the device executed a previous command. Per device echo is only implemented for HF2. For other device types it is a synonym to ziAPISync, and deviceSerial parameter is ignored.
Parameters
Name | Type | Direction | Description |
---|---|---|---|
conn | ZIConnection | in | Pointer to the ZIConnection that is to be synchronized |
deviceSerial | const char * | in | The serial of the device to get the echo from, e.g., dev1000 |
Returns
- ZI_INFO_SUCCESS on success
- ZI_ERROR_TIMEOUT when communication timed out
- Other return codes may also be returned, for a detailed error message use ziAPIGetLastError.