Enabled

The enabled state of a device trigger input determines whether an input is selected as trigger source. More...

Collaboration diagram for Enabled:

Functions
TIEPIE_HW_API tiepie_hw_bool	tiepie_hw_device_trigger_input_get_enabled (tiepie_hw_handle handle, uint16_t input)
	Check whether a device trigger input is enabled.
TIEPIE_HW_API tiepie_hw_bool	tiepie_hw_device_trigger_input_set_enabled (tiepie_hw_handle handle, uint16_t input, tiepie_hw_bool value)
	To select a device trigger input as trigger source, set trigger input enabled.

Detailed 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 (TIEPIE_HW_BOOL_FALSE).

Function Documentation

tiepie_hw_device_trigger_input_get_enabled()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_device_trigger_input_get_enabled	(	tiepie_hw_handle	handle,
		uint16_t	input
	)

Check whether a device trigger input is enabled.

Parameters

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

Returns

TIEPIE_HW_BOOL_TRUE if enabled, TIEPIE_HW_BOOL_FALSE otherwise.

Status values

TIEPIE_HW_STATUS_INVALID_INPUT
TIEPIE_HW_STATUS_NOT_AVAILABLE	With the current settings, the trigger input is not available.
TIEPIE_HW_STATUS_NOT_SUPPORTED	The device has no trigger inputs.
TIEPIE_HW_STATUS_INVALID_HANDLE
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS

See also

tiepie_hw_device_trigger_input_set_enabled

Since

1.0

tiepie_hw_device_trigger_input_set_enabled()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_device_trigger_input_set_enabled	(	tiepie_hw_handle	handle,
		uint16_t	input,
		tiepie_hw_bool	value
	)

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

Parameters

[in]	handle	A device handle identifying the device.
[in]	input	The trigger input index identifying the trigger input, 0 to Dev_trIn_get_count() - 1.
[in]	value	TIEPIE_HW_BOOL_TRUE or TIEPIE_HW_BOOL_FALSE.

Returns

TIEPIE_HW_BOOL_TRUE if enabled, TIEPIE_HW_BOOL_FALSE otherwise.

Status values

TIEPIE_HW_STATUS_INVALID_INPUT
TIEPIE_HW_STATUS_NOT_AVAILABLE	With the current settings, the trigger input is not available.
TIEPIE_HW_STATUS_NOT_SUPPORTED	The device has no trigger inputs.
TIEPIE_HW_STATUS_INVALID_HANDLE
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS

See also

tiepie_hw_device_trigger_input_get_enabled

Since

1.0