PTIMERAPCROUTINE callback function (synchapi.h)

Article
02/22/2024

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

PTIMERAPCROUTINE Ptimerapcroutine;

void Ptimerapcroutine(
  [in, optional] LPVOID lpArgToCompletionRoutine,
  [in]           DWORD dwTimerLowValue,
  [in]           DWORD dwTimerHighValue
)
{...}

Parameters

[in, optional] lpArgToCompletionRoutine

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

[in] dwTimerLowValue

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.

[in] dwTimerHighValue

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

None

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

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	synchapi.h (include Windows.h)

Share via