SetTimer

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

This function creates a timer with the specified time-out value.

UINT
SetTimer( HWND
hWnd
, UINT
nIDEvent
, UINT
uElapse
, TIMERPROC
lpTimerFunc
);

Parameters

hWnd

Handle to the window to be associated with the timer. This window must be owned by the calling thread. If this parameter is NULL, no window is associated with the timer and the nIDEventparameter is ignored.

nIDEvent

Specifies a nonzero timer identifier. If the hWndparameter is NULL, this parameter is ignored.

uElapse

Specifies the time-out value, in milliseconds.

lpTimerFunc

Long pointer to the function to be notified when the time-out value elapses. For more information about the function, see TimerProc.

If lpTimerFuncis NULL, the system posts a WM_TIMERmessage to the application queue. The hwndmember of the message's MSGstructure contains the value of the hWndparameter.

Return Values

An integer identifying the new timer indicates success. An application can pass this value, or the string identifier, if it exists, to the KillTimerfunction to destroy the timer. Zero indicates failure. To get extended error information, call GetLastError.

Remarks

If the uElapseparameter is set to INFINITE, KillTimerfails to destroy the timer.

An application can process WM_TIMER messages by including a WM_TIMER case statement in the window procedure or by specifying a TimerProccallback function when creating the timer. When you specify a TimerProccallback 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 TimerProcinstead of processing WM_TIMER.

The wParamparameter of the WM_TIMER message contains the value of the nIDEventparameter.

Requirements

Runs on	Versions	Defined in	Include	Link to
Windows CE OS	2.0 and later	Winuser.h

Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.