Notifications

Description

Notifications that indicate an object change.

LibTiePie can notify the calling application that an object changed in different ways:

• by calling a callback function
• by setting a events
• by sending a message (Windows only)

Functions
void	ObjSetEventCallback (LibTiePieHandle_t hHandle, TpCallbackEvent_t pCallback, void *pData)
	Set a callback function which is called when an event occurs. More...
bool8_t	ObjGetEvent (LibTiePieHandle_t hHandle, uint32_t *pEvent, uint32_t *pValue)
	Get an event form the event queue. More...
void	ObjSetEventEvent (LibTiePieHandle_t hHandle, int fdEvent)
	Set an event file descriptor which is set when an event occurs. More...
void	ObjSetEventEvent (LibTiePieHandle_t hHandle, HANDLE hEvent)
	Set an event object handle which is set when an event occurs. More...
void	ObjSetEventWindowHandle (LibTiePieHandle_t hHandle, HWND hWnd)
	Set a window handle to which a WM_LIBTIEPIE_EVENT message is sent when an event occurs. More...

Function Documentation

void ObjSetEventCallback	(	LibTiePieHandle_t	hHandle,
		TpCallbackEvent_t	pCallback,
		void *	pData
	)

Set a callback function which is called when an event occurs.

Parameters

[in]	hHandle	A handle identifying the object.
[in]	pCallback	A pointer to the callback function. Use NULL to disable.
[in]	pData	Optional user data.

Since

0.6

bool8_t ObjGetEvent	(	LibTiePieHandle_t	hHandle,
		uint32_t *	pEvent,
		uint32_t *	pValue
	)

Get an event form the event queue.

Parameters

[in]	hHandle	A handle identifying the object.
[out]	pEvent	Pointer to store the event.
[out]	pValue	Pointer to store the event value or NULL.

Returns

BOOL8_TRUE if an event is available, BOOL8_FALSE otherwise.

See also

ObjSetEventEvent

Since

0.6

void ObjSetEventEvent	(	LibTiePieHandle_t	hHandle,
		int	fdEvent
	)

Set an event file descriptor which is set when an event occurs.

Parameters

[in]	hHandle	A handle identifying the object.
[in]	fdEvent	An event file descriptor. Use <0 to disable.

See also

ObjGetEvent

Since

0.6

void ObjSetEventEvent	(	LibTiePieHandle_t	hHandle,
		HANDLE	hEvent
	)

Set an event object handle which is set when an event occurs.

Parameters

[in]	hHandle	A handle identifying the object.
[in]	hEvent	A handle to the event object. Use NULL to disable.

See also

ObjGetEvent

Since

0.6

void ObjSetEventWindowHandle	(	LibTiePieHandle_t	hHandle,
		HWND	hWnd
	)

Set a window handle to which a WM_LIBTIEPIE_EVENT message is sent when an event occurs.

The parameters of the message contain the following:

• wParam contains the Event ID.
• lParam contains the event value (channel number when the Event ID is LIBTIEPIE_EVENTID_SCP_SAFEGROUNDERROR, else 0).

Parameters

[in]	hHandle	A handle identifying the object.
[in]	hWnd	A handle to the window whose window procedure is to receive the message. Use NULL to disable.

Since

0.6