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.

Parameters

[in]	hDevice	A device handle identifying the generator.
[in]	pCallback	A pointer to the callback function. Use `NULL` to disable.
[in]	pData	Optional 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_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

void GenSetEventControllableChanged	(	LibTiePieHandle_t	hDevice,
		int	fdEvent
	)

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

Parameters

[in]	hDevice	A device handle identifying the generator.
[in]	fdEvent	An event file descriptor. Use `<0` to disable.

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_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

void GenSetEventControllableChanged	(	LibTiePieHandle_t	hDevice,
		HANDLE	hEvent
	)

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

Parameters

[in]	hDevice	A device handle identifying the generator.
[in]	hEvent	A handle to the event object. Use `NULL` to disable.

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_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

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]	hDevice	A device handle identifying the generator.
[in]	hWnd	A handle to the window whose window procedure is to receive the message. Use `NULL` to disable.
[in]	wParam	Optional user value for the `wParam` parameter of the message.
[in]	lParam	Optional user value for the `lParam` parameter of the message.

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_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.