WinStopTimer: Difference between revisions

← Older edit Newer edit →

Revision as of 07:08, 26 April 2006

WinStopTimer

WinStopTimer(anchorHndl, windowHndl, timerID): Stop the timer timerID.

Parameters

anchorHndl - HAB - input: The anchor block handle.
windowHndl - HWND - input: The window handle.
timerID - ULONG - input: The timer identifier.

Constants

Returns

Returns BOOL with the values of:

TRUE
FALSE

Return from WinGetLastError if WinStopTimer fails:

PMERR_INVALID_HWND

Module

Define (C/C++)

INCL_WINTIMER or INCL_WIN or INCL_PM

Export name/Ordinal

Calling conversion

Cdecl32

Example Code

HAB   anchorHndl;
HWND  windowHndl;
ULONG timerID;
BOOL  rc;
...
rc = WinStopTimer(anchorHndl, windowHndl, timerID);
...

Related Functions

WinGetCurrentTime WinQueryMsgTime WinStartTimer

Notes

No further messages are received from the timer after WinStopTimer is called. This includes the timer having timed out since the last call to WinGetMsg.

@@ Line 1: / Line 1: @@
 == WinStopTimer ==
-; WinStopTimer(anchorHndl, windowHndl, timerID) :
+; WinStopTimer(anchorHndl, windowHndl, timerID) : Stop the timer timerID.
-Stop the timer timerID.
 === Parameters ===
-; anchorHndl - [[OS2_API:DataType:HAB|HAB]] - input :
+; anchorHndl - [[OS2_API:DataType:HAB|HAB]] - input : The anchor block handle.
-The anchor block handle.
+; windowHndl - [[OS2_API:DataType:HWND|HWND]] - input : The window handle.
-; windowHndl - [[OS2_API:DataType:HWND|HWND]] - input :
+; timerID - [[OS2_API:DataType:ULONG|ULONG]] - input : The timer identifier.
-The window handle.
-; timerID - [[OS2_API:DataType:ULONG|ULONG]] - input :
-The timer identifier.
 === Constants ===