WinStopTimer: Difference between revisions

Latest revision as of 18:58, 16 January 2019

Stop the timer timerID.

Syntax

WinStopTimer(anchorHndl, windowHndl, timerID)

Parameters

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

Returns

Returns BOOL with the values of:

TRUE
FALSE

Return from WinGetLastError if WinStopTimer fails:

PMERR_INVALID_HWND

Define (C/C++)

INCL_WINTIMER or INCL_WIN or INCL_PM

Calling Convention

Cdecl32

Example Code

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

Related Functions

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 ==
+Stop the timer timerID.
-; WinStopTimer(anchorHndl, windowHndl, timerID) : Stop the timer timerID.
+==Syntax==
+ WinStopTimer(anchorHndl, windowHndl, timerID)
 === Parameters ===
-; anchorHndl - [[OS2_API:DataType:HAB|HAB]] - input : The anchor block handle.
+; anchorHndl - [[HAB]] - input : The anchor block handle.
-; windowHndl - [[OS2_API:DataType:HWND|HWND]] - input : The window handle.
+; windowHndl - [[HWND]] - input : The window handle.
-; timerID - [[OS2_API:DataType:ULONG|ULONG]] - input : The timer identifier.
+; timerID - [[ULONG]] - input : The timer identifier.
-=== Constants ===
 === Returns ===
-Returns [[OS2_API:DataType:BOOL|BOOL]] with the values of:
+Returns [[BOOL]] with the values of:
-* [[OS2_API:Constant:TRUE|TRUE]]
+*[[TRUE]]
-* [[OS2_API:Constant:FALSE|FALSE]]
+*[[FALSE]]
-Return from [[OS2_API:WinGetLastError|WinGetLastError]] if [[OS2_API:WinStopTimer|WinStopTimer]] fails:
-* [[OS2 API:PMI:error#PMERR_INVALID_HWND|PMERR_INVALID_HWND]]
-=== Module ===
+Return from [[WinGetLastError]] if ''WinStopTimer'' fails:
+* [[PM Error Codes#PMERR_INVALID_HWND|PMERR_INVALID_HWND]]
 === Define (C/C++) ===
 INCL_WINTIMER or INCL_WIN or INCL_PM
-=== Export name/Ordinal ===
+=== Calling Convention ===
-=== Calling conversion ===
 [[Cdecl32]]
 === Example Code ===
-  [[OS2 API:DataType:HAB|HAB]]   anchorHndl;
+  HAB   anchorHndl;
-  [[OS2 API:DataType:HWND|HWND]]  windowHndl;
+  HWND  windowHndl;
-  [[OS2 API:DataType:ULONG|ULONG]] timerID;
+  ULONG timerID;
-  [[OS2 API:DataType:BOOL|BOOL]]  rc;
+  BOOL  rc;
   ...
   rc = WinStopTimer(anchorHndl, windowHndl, timerID);
- ...
 === Related Functions ===
-[[OS2 API:WinGetCurrentTime|WinGetCurrentTime]] [[OS2_API:WinQueryMsgTime|WinQueryMsgTime]] [[OS2_API:WinStartTimer|WinStartTimer]]
+*[[WinGetCurrentTime]]
+*[[WinQueryMsgTime]]
+*[[WinStartTimer]]
 === Notes ===
-No further messages are received from the timer after [[OS2 API:WinStopTimer|WinStopTimer]] is called.  This includes the timer having timed out since the last call to [[OS2_API:WinGetMsg|WinGetMsg]].
+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]].
-=== OS Version Introduced ===
-[[OS2_API | Back to OS/2 API]]
-[[Category:The OS/2 API Project]]
+[[Category:Win]]