libtiepie-hw  1.1.3

Obtain information of a device trigger output. More...

Collaboration diagram for Info:

Functions

TIEPIE_HW_API uint32_t tiepie_hw_device_trigger_output_get_id (tiepie_hw_handle handle, uint16_t output)
 Get the id of a specified device trigger output. More...
 
TIEPIE_HW_API uint32_t tiepie_hw_device_trigger_output_get_name (tiepie_hw_handle handle, uint16_t output, char *buffer, uint32_t length)
 Get the name of a specified device trigger output. More...
 
TIEPIE_HW_API tiepie_hw_bool tiepie_hw_device_trigger_output_trigger (tiepie_hw_handle handle, uint16_t output)
 Trigger the specified device trigger output. More...
 

Detailed Description

Obtain information of a device trigger output.

The following information of a device trigger output is available:

Function Documentation

◆ tiepie_hw_device_trigger_output_get_id()

TIEPIE_HW_API uint32_t tiepie_hw_device_trigger_output_get_id ( tiepie_hw_handle  handle,
uint16_t  output 
)

Get the id of a specified device trigger output.

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
The trigger output id, a TIEPIE_HW_TOID_* value.
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_get_output_index_byId()
Since
1.0

◆ tiepie_hw_device_trigger_output_get_name()

TIEPIE_HW_API uint32_t tiepie_hw_device_trigger_output_get_name ( tiepie_hw_handle  handle,
uint16_t  output,
char *  buffer,
uint32_t  length 
)

Get the name of a specified device trigger output.

Parameters
[in]handleA device handle identifying the device.
[in]outputThe trigger output index identifying the trigger output, 0 to Dev_trOut_get_count() - 1.
[out]bufferA pointer to a buffer for the name.
[in]lengthThe length of the buffer, in bytes.
Returns
The length of the name in bytes, excluding terminating zero.
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
Since
1.0

◆ tiepie_hw_device_trigger_output_trigger()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_device_trigger_output_trigger ( tiepie_hw_handle  handle,
uint16_t  output 
)

Trigger the specified device trigger output.

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 successful, TIEPIE_HW_BOOL_FALSE otherwise.
Status values
TIEPIE_HW_STATUS_UNSUCCESSFUL
TIEPIE_HW_STATUS_INVALID_OUTPUT
TIEPIE_HW_STATUS_NOT_SUPPORTED The device has no trigger outputs or the trigger output doesn't support manual triggering.
TIEPIE_HW_STATUS_INVALID_HANDLE
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
Since
1.0