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.
TIEPIE_HW_API tiepie_hw_bool	tiepie_hw_object_is_removed (tiepie_hw_handle handle)
	Check whether an object is removed.
TIEPIE_HW_API uint64_t	tiepie_hw_object_get_interfaces (tiepie_hw_handle handle)
	Check which interfaces are supported by the specified object.

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

)

Close a object.

When closing a object, its handle becomes invalid and must not be used again.

Parameters

[in]

handle

A handle identifying the object.

Status values

TIEPIE_HW_STATUS_INVALID_HANDLE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS

See also

tiepie_hw_devicelistitem_open_device

tiepie_hw_devicelistitem_open_oscilloscope

tiepie_hw_devicelistitem_open_generator

tiepie_hw_devicelistitem_get_server

tiepie_hw_network_servers_get_by_index

tiepie_hw_network_servers_get_by_url

Since

1.0

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]

handle

A 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]

handle

A 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