LibTiePie  0.9.14
Library for interfacing TiePie engineering instruments

Description

The enabled state of a device trigger input determines whether an input is selected as trigger source.

By default, all device trigger inputs are disabled (BOOL8_FALSE).

Functions

bool8_t DevTrInGetEnabled (LibTiePieHandle_t hDevice, uint16_t wInput)
 Check whether a device trigger input is enabled. More...
 
bool8_t DevTrInSetEnabled (LibTiePieHandle_t hDevice, uint16_t wInput, bool8_t bEnable)
 To select a device trigger input as trigger source, set trigger input enabled. More...
 

Function Documentation

bool8_t DevTrInGetEnabled ( LibTiePieHandle_t  hDevice,
uint16_t  wInput 
)

Check whether a device trigger input is enabled.

Parameters
[in]hDeviceA device handle identifying the device.
[in]wInputThe trigger input index identifying the trigger input, 0 to DevTrInGetCount() - 1.
Returns
BOOL8_TRUE if enabled, BOOL8_FALSE otherwise.
Status values
INVALID_INPUT The requested trigger input is invalid.
NOT_AVAILABLE With the current settings, the trigger input is not available.
NOT_SUPPORTED The device has no trigger inputs.
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
DevTrInSetEnabled
Since
0.4.1
bool8_t DevTrInSetEnabled ( LibTiePieHandle_t  hDevice,
uint16_t  wInput,
bool8_t  bEnable 
)

To select a device trigger input as trigger source, set trigger input enabled.

Parameters
[in]hDeviceA device handle identifying the device.
[in]wInputThe trigger input index identifying the trigger input, 0 to DevTrInGetCount() - 1.
[in]bEnableBOOL8_TRUE or BOOL8_FALSE.
Returns
BOOL8_TRUE if enabled, BOOL8_FALSE otherwise.
Status values
INVALID_INPUT The requested trigger input is invalid.
NOT_AVAILABLE With the current settings, the trigger input is not available.
NOT_SUPPORTED The device has no trigger inputs.
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
DevTrInGetEnabled
Since
0.4.1