Info

Description

Obtain information of a device trigger input.

The following information of a device trigger input is available:

• Availability
• ID
• Name

Functions
bool8_t	DevTrInIsAvailable (LibTiePieHandle_t hDevice, uint16_t wInput)
	Check whether a device trigger input is available. More...
uint32_t	DevTrInGetId (LibTiePieHandle_t hDevice, uint16_t wInput)
	Get the id of a specified device trigger input. More...
uint32_t	DevTrInGetName (LibTiePieHandle_t hDevice, uint16_t wInput, char *pBuffer, uint32_t dwBufferLength)
	Get the name of a specified device trigger input. More...

Function Documentation

bool8_t DevTrInIsAvailable	(	LibTiePieHandle_t	hDevice,
		uint16_t	wInput
	)

Check whether a device trigger input is available.

Depending on other settings of a device, a device trigger input may be not available. E.g. when the measure mode of an oscilloscope is set to streaming, device trigger inputs are not available.

Parameters

[in]	hDevice	A device handle identifying the device.
[in]	wInput	The trigger input index identifying the trigger input, 0 to DevTrInGetCount() - 1.

Returns

BOOL8_TRUE if available, BOOL8_FALSE otherwise.

Status values

INVALID_INPUT	The requested trigger input is invalid.
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_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

Since

0.4.4

uint32_t DevTrInGetId	(	LibTiePieHandle_t	hDevice,
		uint16_t	wInput
	)

Get the id of a specified device trigger input.

Parameters

[in]	hDevice	A device handle identifying the device.
[in]	wInput	The trigger input index identifying the trigger input, 0 to DevTrInGetCount() - 1.

Returns

The trigger input id, a TIID_* value.

Status values

INVALID_INPUT	The requested trigger input is invalid.
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_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also

DevTrGetInputIndexById()

Since

0.4.4

uint32_t DevTrInGetName	(	LibTiePieHandle_t	hDevice,
		uint16_t	wInput,
		char *	pBuffer,
		uint32_t	dwBufferLength
	)

Get the name of a specified device trigger input.

Parameters

[in]	hDevice	A device handle identifying the device.
[in]	wInput	The trigger input index identifying the trigger input, 0 to DevTrInGetCount() - 1.
[out]	pBuffer	A pointer to a buffer for the name.
[in]	dwBufferLength	The length of the buffer, in bytes.

Returns

The length of the name in bytes, excluding terminating zero.

Status values

INVALID_INPUT	The requested trigger input is invalid.
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_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

Since

0.4.1