6.8 WFMSetTimer

HRESULT WFMSetTimer( hWnd, lpContext, dwTimeVal, lpwTimerID )

Starts a system timer.

Parameters HWND hWnd

The window to which the requested timer message is to be posted.

LPVOID lpContext

Context pointer supplied by the service provider requesting the timer; may be NULL.

DWORD dwTimeVal

Timer value (in milliseconds).

LPWORD lpwTimerID

Pointer to the timer identifier (returned parameter).

Comments The WFMSetTimer function requests the XFS Manager to start a system timer with the specified time value; when that time interval expires, the XFS Manager posts a WFS_TIMER_EVENT message to the specified hWnd, containing the wTimerID value and the lpContext pointer.

Error Codes If the function return is not WFS_SUCCESS, it is one of the following error conditions:

WFS_ERR_INVALID_HWND

The hWnd parameter is not a valid window handle.

WFS_ERR_INVALID_POINTER

A pointer parameter does not point to accessible memory.