Export (0) Print
Expand All
Expand Minimize

CancelWaitableTimer function

Sets the specified waitable timer to the inactive state.

Syntax


BOOL WINAPI CancelWaitableTimer(
  _In_  HANDLE hTimer
);

Parameters

hTimer [in]

A handle to the timer object. The CreateWaitableTimer or OpenWaitableTimer function returns this handle. The handle must have the TIMER_MODIFY_STATE access right. For more information, see Synchronization Object Security and Access Rights.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

The CancelWaitableTimer function does not change the signaled state of the timer. It stops the timer before it can be set to the signaled state and cancels outstanding APCs. Therefore, threads performing a wait operation on the timer remain waiting until they time out or the timer is reactivated and its state is set to signaled. If the timer is already in the signaled state, it remains in that state.

To reactivate the timer, call the SetWaitableTimer function.

To compile an application that uses this function, define _WIN32_WINNT as 0x0400 or later. For more information, see Using the Windows Headers.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

WinBase.h on Windows XP, Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008, and Windows Server 2008 R2 (include Windows.h);
Synchapi.h on Windows 8 and Windows Server 2012

Library

Kernel32.lib

DLL

Kernel32.dll

See also

CreateWaitableTimer
OpenWaitableTimer
SetWaitableTimer
Synchronization Functions
Waitable Timer Objects

 

 

Community Additions

ADD
Show:
© 2014 Microsoft