libtiepie-hw  1.1.3

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

Collaboration diagram for Enabled:

Functions

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_device_trigger_output_get_enabled (tiepie_hw_handle handle, uint16_t output)
 Check whether a trigger output is enabled. More...
 
TIEPIE_HW_API tiepie_hw_bool tiepie_hw_device_trigger_output_set_enabled (tiepie_hw_handle handle, uint16_t output, tiepie_hw_bool value)
 Set trigger output enable. More...
 

Detailed Description

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

By default, all trigger outputs are disabled.

Function Documentation

◆ tiepie_hw_device_trigger_output_get_enabled()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_device_trigger_output_get_enabled ( tiepie_hw_handle  handle,
uint16_t  output 
)

Check whether a trigger output is enabled.

Parameters
[in]handleA device handle identifying the device.
[in]outputThe trigger output index identifying the trigger output, 0 to Dev_trOut_get_count() - 1.
Returns
TIEPIE_HW_BOOL_TRUE if enabled, TIEPIE_HW_BOOL_FALSE otherwise.
Status values
TIEPIE_HW_STATUS_INVALID_OUTPUT
TIEPIE_HW_STATUS_NOT_SUPPORTED The device has no trigger outputs.
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_output_set_enabled
Since
1.0

◆ tiepie_hw_device_trigger_output_set_enabled()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_device_trigger_output_set_enabled ( tiepie_hw_handle  handle,
uint16_t  output,
tiepie_hw_bool  value 
)

Set trigger output enable.

Parameters
[in]handleA device handle identifying the device.
[in]outputThe trigger output index identifying the trigger output, 0 to Dev_trOut_get_count() - 1.
[in]valueTIEPIE_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_OUTPUT
TIEPIE_HW_STATUS_NOT_SUPPORTED The device has no trigger outputs.
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_output_get_enabled
Since
1.0