Enabled

Description

The enabled state of a device trigger output determines whether an output is used.

By default, all trigger outputs are disabled (BOOL8_FALSE).

Functions
bool8_t	DevTrOutGetEnabled (TpDeviceHandle_t hDevice, uint16_t wOutput)
	Check whether a trigger output is enabled. More...
bool8_t	DevTrOutSetEnabled (TpDeviceHandle_t hDevice, uint16_t wOutput, bool8_t bEnable)
	Set trigger output enable. More...

Function Documentation

bool8_t DevTrOutGetEnabled	(	TpDeviceHandle_t	hDevice,
		uint16_t	wOutput
	)

Check whether a trigger output is enabled.

Parameters

hDevice	A device handle identifying the device.
wOutput	The trigger output index identifying the trigger output, 0 to DevTrOutGetCount() - 1.

Returns

BOOL8_TRUE if enabled, BOOL8_FALSE otherwise.

Status values

INVALID_OUTPUT	The requested trigger output is not valid.
NOT_SUPPORTED	The device has no trigger outputs.
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

DevTrOutSetEnabled

Since

0.4.1

bool8_t DevTrOutSetEnabled	(	TpDeviceHandle_t	hDevice,
		uint16_t	wOutput,
		bool8_t	bEnable
	)

Set trigger output enable.

Parameters

hDevice	A device handle identifying the device.
wOutput	The trigger output index identifying the trigger output, 0 to DevTrOutGetCount() - 1.
bEnable	BOOL8_TRUE or BOOL8_FALSE.

Returns

BOOL8_TRUE if enabled, BOOL8_FALSE otherwise.

Status values

INVALID_OUTPUT	The requested trigger output is not valid.
NOT_SUPPORTED	The device has no trigger outputs.
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

DevTrOutGetEnabled

Since

0.4.1