WaitOrTimerCallback callback function (Windows)

Switch View :
ScriptFree
WaitOrTimerCallback callback function

Applies to: desktop apps only

An application-defined function that serves as the starting address for a timer callback or a registered wait callback. Specify this address when calling the CreateTimerQueueTimer, RegisterWaitForSingleObject function.

The WAITORTIMERCALLBACK type defines a pointer to this callback function. WaitOrTimerCallback is a placeholder for the application-defined function name.

Syntax

VOID CALLBACK WaitOrTimerCallback(
  __in  PVOID lpParameter,
  __in  BOOLEAN TimerOrWaitFired
);

Parameters

lpParameter [in]

The thread data passed to the function using a parameter of the CreateTimerQueueTimer or RegisterWaitForSingleObject function.

TimerOrWaitFired [in]

If this parameter is TRUE, the wait timed out. If this parameter is FALSE, the wait event has been signaled. (This parameter is always TRUE for timer callbacks.)

Return value

This function does not return a value.

Remarks

This callback function must not call the TerminateThread function.

Examples

For an example that uses this callback function, see Using Timer Queues.

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

Header

WinBase.h (include Windows.h)

See also

CreateTimerQueueTimer
RegisterWaitForSingleObject
Synchronization Functions

 

 

Send comments about this topic to Microsoft

Build date: 3/7/2012