SetWaitableTimerEx function (synchapi.h)
Activates the specified waitable timer and provides context information for the timer. When the due time arrives, the timer is signaled and the thread that set the timer calls the optional completion routine.
Syntax
BOOL SetWaitableTimerEx(
[in] HANDLE hTimer,
[in] const LARGE_INTEGER *lpDueTime,
[in] LONG lPeriod,
[in] PTIMERAPCROUTINE pfnCompletionRoutine,
[in] LPVOID lpArgToCompletionRoutine,
[in] PREASON_CONTEXT WakeContext,
[in] ULONG TolerableDelay
);
Parameters
[in] hTimer
A handle to the timer object. The CreateWaitableTimer or OpenWaitableTimer function returns this handle.
The handle must have the TIMER_MODIFY_STATE access right. For more information, see Synchronization Object Security and Access Rights.
[in] lpDueTime
The time after which the state of the timer is to be set to signaled, in 100 nanosecond intervals. Use the format described by the FILETIME structure. Positive values indicate absolute time. Be sure to use a UTC-based absolute time, as the system uses UTC-based time internally. Negative values indicate relative time. The actual timer accuracy depends on the capability of your hardware. For more information about UTC-based time, see System Time.
Windows XP, Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 and Windows Server 2008 R2: If relative time is specified, the timer includes time spent in low-power states. For example, the timer continues counting down while the computer is asleep.
Windows 8 and newer, Windows Server 2012 and newer: If relative time is specified, the timer does not include time spent in low-power states. For example, the timer does not continue counting down while the computer is asleep.
[in] lPeriod
The period of the timer, in milliseconds. If lPeriod is zero, the timer is signaled once. If lPeriod is greater than zero, the timer is periodic. A periodic timer automatically reactivates each time the period elapses, until the timer is canceled using the CancelWaitableTimer function or reset using SetWaitableTimerEx. If lPeriod is less than zero, the function fails.
[in] pfnCompletionRoutine
A pointer to an optional completion routine. The completion routine is application-defined function of type PTIMERAPCROUTINE to be executed when the timer is signaled. For more information on the timer callback function, see TimerAPCProc. For more information about APCs and thread pool threads, see Remarks.
[in] lpArgToCompletionRoutine
A pointer to a structure that is passed to the completion routine.
[in] WakeContext
Pointer to a REASON_CONTEXT structure that contains context information for the timer.
[in] TolerableDelay
The tolerable delay for expiration time, in milliseconds.
Return value
If the function succeeds, the return value is nonzero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.
Remarks
The SetWaitableTimerEx function is similar to the SetWaitableTimer function, except SetWaitableTimerEx can be used to specify a context string and a tolerable delay for expiration of the timer.
To compile an application that uses this function, define _WIN32_WINNT as 0x0601 or later. For more information, see Using the Windows Headers.
Timers are initially inactive. To activate a timer, call SetWaitableTimerEx. If the timer is already active when you call SetWaitableTimerEx, the timer is stopped, then it is reactivated. Stopping the timer in this manner does not set the timer state to signaled, so threads blocked in a wait operation on the timer remain blocked. However, it does cancel any pending completion routines.
When the specified due time arrives, the timer becomes inactive, and the optional APC is queued to the thread that set the timer if there is no outstanding APC already queued. The state of the timer is set to signaled, the timer is reactivated using the specified period, and the thread that set the timer calls the completion routine when it enters an alertable wait state. For more information, see QueueUserAPC. Note that APCs do not work as well as other signaling mechanisms for thread pool threads because the system controls the lifetime of thread pool threads, so it is possible for a thread to be terminated before the notification is delivered. Instead of using the pfnCompletionRoutine parameter or another APC-based signaling mechanism, use a waitable object such as a timer created with CreateThreadpoolTimer. For I/O, use an I/O completion object created with CreateThreadpoolIo or an hEvent-based OVERLAPPED structure where the event can be passed to the SetThreadpoolWait function.
If the thread that set the timer terminates and there is an associated completion routine, the timer is canceled. However, the state of the timer remains unchanged. If there is no completion routine, then terminating the thread has no effect on the timer.
When a manual-reset timer is set to the signaled state, it remains in this state until SetWaitableTimerEx is called to reset the timer. As a result, a periodic manual-reset timer is set to the signaled state when the initial due time arrives and remains signaled until it is reset. When a synchronization timer is set to the signaled state, it remains in this state until a thread completes a wait operation on the timer object.
If the system time is adjusted, the due time of any outstanding absolute timers is adjusted.
If the thread that called SetWaitableTimerEx exits, the timer is canceled. This stops the timer before it can be set to the signaled state and cancels outstanding APCs; it does not change the signaled state of the timer.
To use a timer to schedule an event for a window, use the SetTimer function.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 7 [desktop apps | UWP apps] |
| Minimum supported server | Windows Server 2008 R2 [desktop apps | UWP apps] |
| Target Platform | Windows |
| Header | synchapi.h (include Windows.h) |
| Library | Kernel32.lib |
| DLL | Kernel32.dll |