This topic has not yet been rated - Rate this topic

TimerAPCProc callback function

Applies to: desktop apps only

An application-defined timer completion routine. Specify this address when calling the SetWaitableTimer function. The PTIMERAPCROUTINE type defines a pointer to this callback function. TimerAPCProc is a placeholder for the application-defined function name.

Syntax

VOID CALLBACK TimerAPCProc(
  __in_opt  LPVOID lpArgToCompletionRoutine,
  __in      DWORD dwTimerLowValue,
  __in      DWORD dwTimerHighValue
);

Parameters

lpArgToCompletionRoutine [in, optional]

The value passed to the function using the lpArgToCompletionRoutine parameter of the SetWaitableTimer function.

dwTimerLowValue [in]

The low-order portion of the UTC-based time at which the timer was signaled. This value corresponds to the dwLowDateTime member of the FILETIME structure. For more information about UTC-based time, see System Time.

dwTimerHighValue [in]

The high-order portion of the UTC-based time at which the timer was signaled. This value corresponds to the dwHighDateTime member of the FILETIME structure.

Return value

This function does not return a value.

Remarks

The completion routine is executed by the thread that activates the timer using SetWaitableTimer. However, the thread must be in an alertable state. For more information, see Asynchronous Procedure Calls.

Examples

For an example, see Using a Waitable Timer with an Asynchronous Procedure Call.

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

Header

WinBase.h (include Windows.h)

See also

SetWaitableTimer

 

 

Send comments about this topic to Microsoft

Build date: 3/7/2012

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ