libtiepie-hw  1.1.3

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

Collaboration diagram for Info:

Functions

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_device_trigger_input_is_available (tiepie_hw_handle handle, uint16_t input)
 Check whether a device trigger input is available. More...
 
TIEPIE_HW_API uint32_t tiepie_hw_device_trigger_input_get_id (tiepie_hw_handle handle, uint16_t input)
 Get the id of a specified device trigger input. More...
 
TIEPIE_HW_API uint32_t tiepie_hw_device_trigger_input_get_name (tiepie_hw_handle handle, uint16_t input, char *buffer, uint32_t length)
 Get the name of a specified device trigger input. More...
 

Detailed Description

Obtain information of a device trigger input.

The following information of a device trigger input is available:

Function Documentation

◆ tiepie_hw_device_trigger_input_is_available()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_device_trigger_input_is_available ( tiepie_hw_handle  handle,
uint16_t  input 
)

Check whether a device trigger input is available.

Depending on other settings of a device, a device trigger input may be not available. E.g. when the measure mode of an oscilloscope is set to streaming, device trigger inputs are not available.

Parameters
[in]handleA device handle identifying the device.
[in]inputThe trigger input index identifying the trigger input, 0 to Dev_trIn_get_count() - 1.
Returns
TIEPIE_HW_BOOL_TRUE if available, TIEPIE_HW_BOOL_FALSE otherwise.
Status values
TIEPIE_HW_STATUS_INVALID_INPUT
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
Since
1.0

◆ tiepie_hw_device_trigger_input_get_id()

TIEPIE_HW_API uint32_t tiepie_hw_device_trigger_input_get_id ( tiepie_hw_handle  handle,
uint16_t  input 
)

Get the id of a specified device trigger input.

Parameters
[in]handleA device handle identifying the device.
[in]inputThe trigger input index identifying the trigger input, 0 to Dev_trIn_get_count() - 1.
Returns
The trigger input id, a TIEPIE_HW_TIID_* value.
Status values
TIEPIE_HW_STATUS_INVALID_INPUT
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_get_input_index_by_id
Since
1.0

◆ tiepie_hw_device_trigger_input_get_name()

TIEPIE_HW_API uint32_t tiepie_hw_device_trigger_input_get_name ( tiepie_hw_handle  handle,
uint16_t  input,
char *  buffer,
uint32_t  length 
)

Get the name of a specified device trigger input.

Parameters
[in]handleA device handle identifying the device.
[in]inputThe trigger input index identifying the trigger input, 0 to Dev_trIn_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_INPUT
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
Since
1.0