LibTiePie  0.9.15
Library for interfacing TiePie engineering instruments

Description

Obtain information of a device trigger output.

The following information of a device trigger output is available:

Functions

uint32_t DevTrOutGetId (LibTiePieHandle_t hDevice, uint16_t wOutput)
 Get the id of a specified device trigger output. More...
 
uint32_t DevTrOutGetName (LibTiePieHandle_t hDevice, uint16_t wOutput, char *pBuffer, uint32_t dwBufferLength)
 Get the name of a specified device trigger output. More...
 
bool8_t DevTrOutTrigger (LibTiePieHandle_t hDevice, uint16_t wOutput)
 Trigger the specified device trigger output. More...
 

Function Documentation

uint32_t DevTrOutGetId ( LibTiePieHandle_t  hDevice,
uint16_t  wOutput 
)

Get the id of a specified device trigger output.

Parameters
[in]hDeviceA device handle identifying the device.
[in]wOutputThe trigger output index identifying the trigger output, 0 to DevTrOutGetCount() - 1.
Returns
The trigger output id, a TOID_* value.
Status values
INVALID_OUTPUT The requested trigger output is invalid.
NOT_SUPPORTED The device has no trigger outputs.
INVALID_HANDLE The handle to the device is invalid.
OBJECT_GONE The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
See also
DevTrGetOutputIndexById()
Since
0.4.4
uint32_t DevTrOutGetName ( LibTiePieHandle_t  hDevice,
uint16_t  wOutput,
char *  pBuffer,
uint32_t  dwBufferLength 
)

Get the name of a specified device trigger output.

Parameters
[in]hDeviceA device handle identifying the device.
[in]wOutputThe trigger output index identifying the trigger output, 0 to DevTrOutGetCount() - 1.
[out]pBufferA pointer to a buffer for the name.
[in]dwBufferLengthThe length of the buffer, in bytes.
Returns
The length of the name in bytes, excluding terminating zero.
Status values
INVALID_OUTPUT The requested trigger output is invalid.
NOT_SUPPORTED The device has no trigger outputs.
INVALID_HANDLE The handle to the device is invalid.
OBJECT_GONE The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
Since
0.4.1
bool8_t DevTrOutTrigger ( LibTiePieHandle_t  hDevice,
uint16_t  wOutput 
)

Trigger the specified device trigger output.

Parameters
[in]hDeviceA device handle identifying the device.
[in]wOutputThe trigger output index identifying the trigger output, 0 to DevTrOutGetCount() - 1.
Returns
BOOL8_TRUE if successful, BOOL8_FALSE otherwise.
Status values
UNSUCCESSFUL An error occurred during execution of the last called function.
INVALID_OUTPUT The requested trigger output is invalid.
NOT_SUPPORTED The device has no trigger outputs or the trigger output doesn't support manual triggering.
INVALID_HANDLE The handle to the device is invalid.
DEVICE_GONE
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
Since
0.6