Burst completed

Description

Functions to set notifications that are triggered when a generator burst is completed.

Functions
void	GenSetCallbackBurstCompleted (LibTiePieHandle_t hDevice, TpCallback_t pCallback, void *pData)
	Set a callback function which is called when the generator burst is completed. More...
void	GenSetEventBurstCompleted (LibTiePieHandle_t hDevice, int fdEvent)
	Set an event file descriptor which is set when the generator burst is completed. More...
void	GenSetEventBurstCompleted (LibTiePieHandle_t hDevice, HANDLE hEvent)
	Set an event object handle which is set when the generator burst is completed. More...
void	GenSetMessageBurstCompleted (LibTiePieHandle_t hDevice, HWND hWnd, WPARAM wParam, LPARAM lParam)
	Set a window handle to which a WM_LIBTIEPIE_GEN_BURSTCOMPLETED message is sent when the generator burst is completed. More...

Function Documentation

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

Set a callback function which is called when the generator burst is completed.

Deprecated:

Will be removed in future version, see: ObjSetEventCallback()

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.

See also

GenIsBurstActive

Since

0.4.0

void GenSetEventBurstCompleted	(	LibTiePieHandle_t	hDevice,
		int	fdEvent
	)

Set an event file descriptor which is set when the generator burst is completed.

Deprecated:

Will be removed in future version, see: ObjSetEventEvent()

Parameters

[in]	hDevice	A device handle identifying the generator.
[in]	fdEvent	An 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_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also

GenIsBurstActive

Since

0.4.0

void GenSetEventBurstCompleted	(	LibTiePieHandle_t	hDevice,
		HANDLE	hEvent
	)

Set an event object handle which is set when the generator burst is completed.

Deprecated:

Will be removed in future version, see: ObjSetEventEvent()

Parameters

[in]	hDevice	A device handle identifying the generator.
[in]	hEvent	A 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_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also

GenIsBurstActive

Since

0.4.0

void GenSetMessageBurstCompleted	(	LibTiePieHandle_t	hDevice,
		HWND	hWnd,
		WPARAM	wParam,
		LPARAM	lParam
	)

Set a window handle to which a WM_LIBTIEPIE_GEN_BURSTCOMPLETED message is sent when the generator burst is completed.

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.

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

See also

GenIsBurstActive

Since

0.4.0