CWnd::KillTimer

Syntax

BOOL KillTimer( int nIDEvent );

Parameters

nIDEvent

The value of the timer event passed to SetTimer.

Remarks

Kills the timer event identified by nIDEvent from the earlier call to SetTimer. Any pending WM_TIMER messages associated with the timer are removed from the message queue.

Return Value

Specifies the outcome of the function. The value is TRUE if the event was killed. It is FALSE if the KillTimer member function could not find the specified timer event.

See Also

CWnd::SetTimer, ::KillTimer