LibTiePie  0.8.0
Library for interfacing TiePie engineering instruments
Controllable changed

Description

Functions to set notifications that are triggered when the generator controllable state has changed.

In certain conditions like when performing a streaming measurement with the oscilloscope, the generator cannot be controlled.

Functions

void GenSetCallbackControllableChanged (LibTiePieHandle_t hDevice, TpCallback_t pCallback, void *pData)
 Set a callback function which is called when the generator controllable property changes. More...
 
void GenSetEventControllableChanged (LibTiePieHandle_t hDevice, int fdEvent)
 Set an event file descriptor which is set when the generator controllable property changes. More...
 
void GenSetEventControllableChanged (LibTiePieHandle_t hDevice, HANDLE hEvent)
 Set event object handle which is set when the generator controllable property changes. More...
 
void GenSetMessageControllableChanged (LibTiePieHandle_t hDevice, HWND hWnd, WPARAM wParam, LPARAM lParam)
 Set window handle to which a WM_LIBTIEPIE_GEN_CONTROLLABLECHANGED message is sent when the generator controllable property changes. More...
 

Function Documentation

void GenSetCallbackControllableChanged ( LibTiePieHandle_t  hDevice,
TpCallback_t  pCallback,
void *  pData 
)

Set a callback function which is called when the generator controllable property changes.

Deprecated:
Will be removed in future version, see: ObjSetEventCallback()
Parameters
[in]hDeviceA device handle identifying the generator.
[in]pCallbackA pointer to the callback function. Use NULL to disable.
[in]pDataOptional user data.
Status values
INVALID_HANDLE The handle is not a valid generator handle.
OBJECT_GONE The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
See also
GenIsControllable
Since
0.4.0
void GenSetEventControllableChanged ( LibTiePieHandle_t  hDevice,
int  fdEvent 
)

Set an event file descriptor which is set when the generator controllable property changes.

Deprecated:
Will be removed in future version, see: ObjSetEventEvent()
Parameters
[in]hDeviceA device handle identifying the generator.
[in]fdEventAn event file descriptor. Use <0 to disable.
Note
This function is only available on GNU/Linux.
Status values
INVALID_HANDLE The handle is not a valid generator handle.
OBJECT_GONE The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
See also
GenIsControllable
Since
0.4.0
void GenSetEventControllableChanged ( LibTiePieHandle_t  hDevice,
HANDLE  hEvent 
)

Set event object handle which is set when the generator controllable property changes.

Deprecated:
Will be removed in future version, see: ObjSetEventEvent()
Parameters
[in]hDeviceA device handle identifying the generator.
[in]hEventA handle to the event object. Use NULL to disable.
Note
This function is only available on Windows.
Status values
INVALID_HANDLE The handle is not a valid generator handle.
OBJECT_GONE The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
See also
GenIsControllable
Since
0.4.0
void GenSetMessageControllableChanged ( LibTiePieHandle_t  hDevice,
HWND  hWnd,
WPARAM  wParam,
LPARAM  lParam 
)

Set window handle to which a WM_LIBTIEPIE_GEN_CONTROLLABLECHANGED message is sent when the generator controllable property changes.

Deprecated:
Will be removed in future version, see: ObjSetEventWindowHandle()
Parameters
[in]hDeviceA device handle identifying the generator.
[in]hWndA handle to the window whose window procedure is to receive the message. Use NULL to disable.
[in]wParamOptional user value for the wParam parameter of the message.
[in]lParamOptional user value for the lParam parameter of the message.
Note
This function is only available on Windows.
Status values
INVALID_HANDLE The handle is not a valid generator handle.
OBJECT_GONE The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
See also
GenIsControllable
Since
0.4.0