Share via

CWnd::KillTimer

  • Article

Kills the timer event identified by nIDEvent from the earlier call to SetTimer.

BOOL KillTimer( 
   UINT_PTR nIDEvent  
);

Parameters

  • nIDEvent
    The value of the timer event passed to SetTimer.

Return Value

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

Remarks

Pending WM_TIMER messages associated with the timer are not removed from the message queue.

Example

See the example for CWnd::SetTimer.

Requirements

Header: afxwin.h

See Also

Reference

CWnd Class

Hierarchy Chart

CWnd::SetTimer

KillTimer