LibTiePie  0.6.1
Library for interfacing TiePie engineering instruments
Common

Description

Functions common to all objects.

These functions can be called with any handle.

Functions

void ObjClose (LibTiePieHandle_t hHandle)
 Close a object. More...
 
bool8_t ObjIsRemoved (LibTiePieHandle_t hHandle)
 Check whether an object is removed. More...
 
uint64_t ObjGetInterfaces (LibTiePieHandle_t hHandle)
 Check which interface are supported by the specified object. More...
 

Function Documentation

void ObjClose ( LibTiePieHandle_t  hHandle)

Close a object.

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

Parameters
[in]hHandleA handle identifying the object.
Status values
INVALID_HANDLE The handle to the device is invalid.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
See also
LstOpenDevice
LstOpenDeviceProtected
LstOpenOscilloscope
LstOpenGenerator
LstOpenI2CHost
LstDevGetServerHandle
NetSrvGetByIndex
NetSrvGetByURL
Since
0.6
bool8_t ObjIsRemoved ( LibTiePieHandle_t  hHandle)

Check whether an object is removed.

Parameters
[in]hHandleA handle identifying the object.
Returns
BOOL8_TRUE if removed, BOOL8_FALSE otherwise.
Status values
INVALID_HANDLE The handle to the device is invalid.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
Since
0.6
uint64_t ObjGetInterfaces ( LibTiePieHandle_t  hHandle)

Check which interface are supported by the specified object.

Parameters
[in]hHandleA handle identifying the object.
Returns
Set of OR-ed, interface flags.
Status values
INVALID_HANDLE The handle to the device is invalid.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
Since
0.6