LibTiePie  0.4.5
Library for interfacing TiePie engineering instruments
 All Files Functions Typedefs Macros Modules Pages

Description

The device trigger kind determines how the device trigger responds to the device trigger input signal.

Use DevTrInGetKinds() to find out which trigger kinds are supported by the device trigger input. Read more on device trigger kind.

Default value: TK_RISINGEDGE if supported, else TK_FALLINGEDGE.

Functions

uint64_t DevTrInGetKinds (TpDeviceHandle_t hDevice, uint16_t wInput)
 Get the supported trigger kinds for a specified device trigger input. More...
 
uint64_t DevTrInGetKind (TpDeviceHandle_t hDevice, uint16_t wInput)
 Get the currently selected trigger kind for a specified device trigger input. More...
 
uint64_t DevTrInSetKind (TpDeviceHandle_t hDevice, uint16_t wInput, uint64_t qwKind)
 Set the required trigger kind for a specified device trigger input. More...
 

Function Documentation

uint64_t DevTrInGetKinds ( TpDeviceHandle_t  hDevice,
uint16_t  wInput 
)

Get the supported trigger kinds for a specified device trigger input.

Parameters
hDeviceA device handle identifying the device.
wInputThe trigger input index identifying the trigger input, 0 to DevTrInGetCount() - 1.
Returns
Supported trigger input kinds, a set of OR-ed TK_* values.
Status values
INVALID_INPUT The requested trigger input is not valid.
NOT_AVAILABLE With the current settings, the trigger input is not available.
NOT_SUPPORTED The device has no trigger inputs.
INVALID_HANDLEThe handle to the device is invalid.
DEVICE_GONE The device indicated by the device handle is no longer available.
SUCCESS The function executed successfully.
See also
DevTrInGetKind
DevTrInSetKind
Since
0.4.1
uint64_t DevTrInGetKind ( TpDeviceHandle_t  hDevice,
uint16_t  wInput 
)

Get the currently selected trigger kind for a specified device trigger input.

Parameters
hDeviceA device handle identifying the device.
wInputThe trigger input index identifying the trigger input, 0 to DevTrInGetCount() - 1.
Returns
The current trigger kind, a TK_* value.
Status values
INVALID_INPUT The requested trigger input is not valid.
NOT_AVAILABLE With the current settings, the trigger input is not available.
NOT_SUPPORTED The device has no trigger inputs.
INVALID_HANDLEThe handle to the device is invalid.
DEVICE_GONE The device indicated by the device handle is no longer available.
SUCCESS The function executed successfully.
See also
DevTrInGetKinds
DevTrInSetKind
Since
0.4.1
uint64_t DevTrInSetKind ( TpDeviceHandle_t  hDevice,
uint16_t  wInput,
uint64_t  qwKind 
)

Set the required trigger kind for a specified device trigger input.

Parameters
hDeviceA device handle identifying the device.
wInputThe trigger input index identifying the trigger input, 0 to DevTrInGetCount() - 1.
qwKindThe required trigger kind, a TK_* value.
Returns
The actually set trigger kind, a TK_* value.
Status values
INVALID_INPUT The requested trigger input is not valid.
NOT_AVAILABLE With the current settings, the trigger input is not available.
INVALID_VALUE The requested trigger kind is invalid.
NOT_SUPPORTED The device has no trigger inputs.
INVALID_HANDLEThe handle to the device is invalid.
DEVICE_GONE The device indicated by the device handle is no longer available.
SUCCESS The function executed successfully.
See also
DevTrInGetKinds
DevTrInGetKind
Since
0.4.1