Enabled

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 (TpDeviceHandle_t hDevice, uint16_t wInput)
	Check whether a device trigger input is enabled. More...
bool8_t	DevTrInSetEnabled (TpDeviceHandle_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	(	TpDeviceHandle_t	hDevice,
		uint16_t	wInput
	)

Check whether a device trigger input is enabled.

Parameters

hDevice	A device handle identifying the device.
wInput	The 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 not valid.
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.
DEVICE_GONE	The device indicated by the device handle is no longer available.
SUCCESS	The function executed successfully.

See also

DevTrInSetEnabled

Since

0.4.1

bool8_t DevTrInSetEnabled	(	TpDeviceHandle_t	hDevice,
		uint16_t	wInput,
		bool8_t	bEnable
	)

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

Parameters

hDevice	A device handle identifying the device.
wInput	The trigger input index identifying the trigger input, 0 to DevTrInGetCount() - 1.
bEnable	BOOL8_TRUE or BOOL8_FALSE.

Returns

BOOL8_TRUE if enabled, BOOL8_FALSE otherwise.

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_HANDLE	The 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

DevTrInGetEnabled

Since

0.4.1