Jump to content

WinStopTimer: Difference between revisions

From EDM2
m correction to the include constant
m corrected links
Line 15: Line 15:
=== Returns ===
=== Returns ===
Returns [[OS2_API:DataType:BOOL|BOOL]] with the values of:
Returns [[OS2_API:DataType:BOOL|BOOL]] with the values of:
* [[OS2_API:DataType:TRUE|TRUE]]
* [[OS2_API:Constant:TRUE|TRUE]]
* [[OS2_API:DataType:FALSE|FALSE]]
* [[OS2_API:Constant:FALSE|FALSE]]


Return from [[OS2_API:WinGetLastError|WinGetLastError]] if [[OS2_API:WinStopTimer|WinStopTimer]] fails:
Return from [[OS2_API:WinGetLastError|WinGetLastError]] if [[OS2_API:WinStopTimer|WinStopTimer]] fails:

Revision as of 08:11, 23 February 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:

Return from WinGetLastError if WinStopTimer fails:

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.

OS Version Introduced