 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 destroys the specified timer. The system searches the message queue for any pending WM_TIMERmessages associated with the timer and removes them.
BOOL KillTimer( HWND hWnd , UINT uIDEvent );
Parameters
- hWnd
- Handle to the window associated with the specified timer. This value must be the same as the hWndvalue passed to the SetTimerfunction that created the timer.
- uIDEvent
- Specifies the identifier of the timer to be destroyed. If the
window handle passed to
SetTimeris valid, this parameter must be the same as the
uIDEventvalue passed to
SetTimer. If the application calls
SetTimerwith
hWndset to NULL, this parameter must be the timer identifier
returned by
SetTimer.
Return Values
Nonzero indicates success. Zero indicates failure. To get extended error information, call GetLastError.
Remarks
The KillTimerfunction does not remove WM_TIMER messages already posted to the message queue.
If the uElapseparameter of the SetTimerfunction is set to INFINITE, KillTimerfails to destroy the timer.
Requirements
Runs on Versions Defined in Include Link to Windows CE OS 1.0 and later Winbase.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.
See Also
GetLastError, SetTimer, WM_TIMER