WinStartTimer: Difference between revisions

Revision as of 07:07, 26 April 2006

WinStartTimer

WinStartTimer(anchorHndl, windowHndl, timerID, timeout): Start the timer as identified as timerID.

Parameters

anchorHndl - HAB - input: The anchor block handle.
windowHndl - HWND - input: The window handle.

A NULLHANDLE parameter renders timerID ignored. The function will return a unique, non-zero identity to represent the timer. A timer message is posted into the message queue associated with the current thread. The QMSG paramter is set to NULLHANDLE.

timerID - ULONG - input: The timer identifier.

This value must be below TID_USERMAX. Any value above this could clash with system timers.

The TID_SCROLL identity, is created by the scroll bar control. An application typically doesn't see the associated WM_TIMER, which is passed to the scroll-bar control.

The TID_CURSOR identity, is create by the cursor is flashing. The application must pass the associated WM_TIMER onto the default window procedure.

timeout - ULONG - input: The delay time in milliseconds.

For OS/2 Warp 3 and above, the valid value range is 0-4,294,967,295.

For OS/2 2.1 and earlier, the valid value range is 0-65,535.

Constants

Returns

Returns ULONG:

0 An error has occurred.
Anything else - the timerID.

Module

Define (C/C++)

INCL_WINTIMER or INCL_PM or INCL_WIN

Export name/Ordinal

Calling conversion

Cdecl32

Example Code

HAB    anchorHndl;
HWND   windowHndl;
ULONG  timerID;
ULONG  timeout;
ULONG  timerIDStarted;
...
timerIDStarted = WinStartTimer(anchorHndl, windowHndl, timerID, timeout);
...

Related Functions

WinGetCurrentTime WinQueryMsgTime WinStopTimer

Notes

WinStartTimer creates a timer identified by windowHndl and timerID, set to time out every timeout milliseconds. When a timer times out, a WM_TIMER message is posted.

The timeout value of zero causes the timer to timeout as fast as possible; this is about 1/18 second.

A second call to this function, for a timer that already exists, resets that timer.

@@ Line 1: / Line 1: @@
 == WinStartTimer ==
-; WinStartTimer(anchorHndl, windowHndl, timerID, timeout) :
+; WinStartTimer(anchorHndl, windowHndl, timerID, timeout) : Start the timer as identified as timerID.
-Start the timer as identified as 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 :
-The window handle.
 A [[OS2 API:DataType:NULLHANDLE|NULLHANDLE]] parameter renders timerID ignored.  The function will return a unique, non-zero identity to represent the timer.  A timer message is posted into the message queue associated with the current thread.  The [[OS2_API:DataType:QMSG|QMSG]] paramter is set to [[OS2_API:DataType:NULLHANDLE|NULLHANDLE]].
-; timerID - [[OS2 API:DataType:ULONG|ULONG]] - input :
+; timerID - [[OS2 API:DataType:ULONG|ULONG]] - input : The timer identifier.
-The timer identifier.
 This value must be below [[OS2 API:Constant:TID#TID_USERMAX|TID_USERMAX]].  Any value above this could clash with system timers.
@@ Line 18: / Line 14: @@
 The [[OS2 API:Constant:TID#TID_CURSOR|TID_CURSOR]] identity, is create by the cursor is flashing.  The application must pass the associated [[OS2_API:Constant:WM#WM_TIMER|WM_TIMER]] onto the default window procedure.
-; timeout - [[OS2 API:DataType:ULONG|ULONG]] - input :
+; timeout - [[OS2 API:DataType:ULONG|ULONG]] - input : The delay time in milliseconds.
-The delay time in milliseconds.
 For OS/2 Warp 3 and above, the valid value range is 0-4,294,967,295.