libtiepie-hw  1.2.5
Common

Functions common to all objects. More...

Collaboration diagram for Common:

Functions

TIEPIE_HW_API void tiepie_hw_object_close (tiepie_hw_handle handle)
 Close a object. More...
 
TIEPIE_HW_API tiepie_hw_bool tiepie_hw_object_is_removed (tiepie_hw_handle handle)
 Check whether an object is removed. More...
 
TIEPIE_HW_API uint64_t tiepie_hw_object_get_interfaces (tiepie_hw_handle handle)
 Check which interfaces are supported by the specified object. More...
 

Detailed Description

Functions common to all objects.

These functions can be called with any handle.

Function Documentation

◆ tiepie_hw_object_close()

TIEPIE_HW_API void tiepie_hw_object_close ( tiepie_hw_handle  handle)

◆ tiepie_hw_object_is_removed()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_object_is_removed ( tiepie_hw_handle  handle)

Check whether an object is removed.

Parameters
[in]handleA handle identifying the object.
Returns
TIEPIE_HW_BOOL_TRUE if removed, TIEPIE_HW_BOOL_FALSE otherwise.
Status values
TIEPIE_HW_STATUS_INVALID_HANDLE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
Since
1.0

◆ tiepie_hw_object_get_interfaces()

TIEPIE_HW_API uint64_t tiepie_hw_object_get_interfaces ( tiepie_hw_handle  handle)

Check which interfaces are supported by the specified object.

Parameters
[in]handleA handle identifying the object.
Returns
Set of OR-ed, interface flags.
Status values
TIEPIE_HW_STATUS_INVALID_HANDLE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
Since
1.0