SetCoalescableTimer function

Creates a timer with the specified time-out value and coalescing tolerance delay.

Syntax


UINT_PTR WINAPI SetCoalescableTimer(
  _In_opt_  HWND hwnd,
  _In_      UINT_PTR nIDEvent,
  _In_      UINT uElapse,
  _In_opt_  TIMERPROC lpTimerFunc,
  _In_      ULONG uToleranceDelay
);

Parameters

hwnd [in, optional]

Type: HWND

A handle to the window to be associated with the timer. This window must be owned by the calling thread. If a NULL value for hWnd is passed in along with an nIDEvent of an existing timer, that timer will be replaced in the same way that an existing non-NULL hWnd timer will be.

nIDEvent [in]

Type: UINT_PTR

A timer identifier. If the hWnd parameter is NULL, and the nIDEvent does not match an existing timer, then the nIDEvent is ignored and a new timer ID is generated. If the hWnd parameter is not NULL and the window specified by hWnd already has a timer with the value nIDEvent, then the existing timer is replaced by the new timer. When SetCoalescableTimer replaces a timer, the timer is reset. Therefore, a message will be sent after the current time-out value elapses, but the previously set time-out value is ignored. If the call is not intended to replace an existing timer, nIDEvent should be 0 if the hWnd is NULL.

uElapse [in]

Type: UINT

The time-out value, in milliseconds.

If uElapse is less than USER_TIMER_MINIMUM (0x0000000A), the timeout is set to USER_TIMER_MINIMUM. If uElapse is greater than USER_TIMER_MAXIMUM (0x7FFFFFFF), the timeout is set to USER_TIMER_MAXIMUM.

If the sum of uElapse and uToleranceDelay exceeds USER_TIMER_MAXIMUM, an ERROR_INVALID_PARAMETER exception occurs.

lpTimerFunc [in, optional]

Type: TIMERPROC

A pointer to the function to be notified when the time-out value elapses. For more information about the function, see TimerProc. If lpTimerFunc is NULL, the system posts a WM_TIMER message to the application queue. The hwnd member of the message's MSG structure contains the value of the hWnd parameter.

uToleranceDelay [in]

Type: ULONG

It can be one of the following values:

ValueMeaning
TIMERV_DEFAULT_COALESCING
0x00000000

Uses the system default timer coalescing.

TIMERV_NO_COALESCING
0xFFFFFFFF

Uses no timer coalescing. When this value is used, the created timer is not coalesced, no matter what the system default timer coalescing is or the application compatiblity flags are.

Note  Do not use this value unless you are certain that the timer requires no coalescing.

0x1 - 0x7FFFFFF5

Specifies the coalescing tolerance delay, in milliseconds.

Applications should set this value to the system default (TIMERV_DEFAULT_COALESCING) or the largest value possible.

If the sum of uElapse and uToleranceDelay exceeds USER_TIMER_MAXIMUM (0x7FFFFFFF), an ERROR_INVALID_PARAMETER exception occurs.

See Windows Timer Coalescing for more details and best practices.

Any other value

An invalid value. If uToleranceDelay is set to an invalid value, the function fails and returns zero.

 

Return value

Type:

Type: UINT_PTR

If the function succeeds and the hWnd parameter is NULL, the return value is an integer identifying the new timer. An application can pass this value to the KillTimer function to destroy the timer.

If the function succeeds and the hWnd parameter is not NULL, then the return value is a nonzero integer. An application can pass the value of the nIDEvent parameter to the KillTimer function to destroy the timer.

If the function fails to create a timer, the return value is zero. To get extended error information, call GetLastError.

Remarks

An application can process WM_TIMER messages by including a WM_TIMER case statement in the window procedure or by specifying a TimerProc callback function when creating the timer. When you specify a TimerProc callback function, the default window procedure calls the callback function when it processes WM_TIMER. Therefore, you need to dispatch messages in the calling thread, even when you use TimerProc instead of processing WM_TIMER.

The wParam parameter of the WM_TIMER message contains the value of the nIDEvent parameter.

The timer identifier, nIDEvent, is specific to the associated window. Another window can have its own timer which has the same identifier as a timer owned by another window. The timers are distinct.

SetTimer can reuse timer IDs in the case where hWnd is NULL.

When uToleranceDelay is set to 0, the system default timer coalescing is used and SetCoalescableTimer behaves the same as SetTimer.

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Winuser.h (include Windows.h)

Library

User32.lib

DLL

User32.dll

See also

Reference
SetTimer
KeSetTimer
KeSetCoalescableTimer
KillTimer
MSG
TimerProc
WM_TIMER
Conceptual
Timers
Using TimersCoalescing timers sample
Sample
Coalescing timers sample

 

 

Community Additions

ADD
Show:
© 2014 Microsoft