LibTiePie  0.9.16
Library for interfacing TiePie engineering instruments
Input(s)

Description

A device can have one or more device trigger inputs, usually available as pins on an extension connector on the instrument.

Use the function DevTrGetInputCount() to determine the amount of available device trigger inputs. To use a device trigger input as trigger source, use the function DevTrInSetEnabled() to enable it.

Modules

 Status
 
 Enabled
 The enabled state of a device trigger input determines whether an input is selected as trigger source.
 
 Kind
 The device trigger kind determines how the device trigger responds to the device trigger input signal.
 
 Info
 Obtain information of a device trigger input.
 

Functions

uint16_t DevTrGetInputCount (LibTiePieHandle_t hDevice)
 Get the number of trigger inputs. More...
 
uint16_t DevTrGetInputIndexById (LibTiePieHandle_t hDevice, uint32_t dwId)
 Get the index of a trigger input identified by its ID. More...
 

Function Documentation

uint16_t DevTrGetInputCount ( LibTiePieHandle_t  hDevice)

Get the number of trigger inputs.

Parameters
[in]hDeviceA device handle identifying the device.
Returns
The number of trigger inputs.
Status values
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.
Since
0.4.1
uint16_t DevTrGetInputIndexById ( LibTiePieHandle_t  hDevice,
uint32_t  dwId 
)

Get the index of a trigger input identified by its ID.

The index is used in the other trigger input functions to identify the trigger input.

Parameters
[in]hDeviceA device handle identifying the device.
[in]dwIdThe trigger input ID, a TIID_* value, identifying the trigger input.
Returns
The trigger input index or LIBTIEPIE_TRIGGERIO_INDEX_INVALID.
Status values
NOT_SUPPORTED The device has no trigger inputs.
INVALID_VALUE The requested ID is invalid.
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
DevTrInGetId()
Since
0.4.4