CancelWaitableTimer 函数 (synchapi.h)

将指定的可等待计时器设置为非活动状态。

语法

BOOL CancelWaitableTimer(
  [in] HANDLE hTimer
);

参数

[in] hTimer

计时器对象的句柄。 CreateWaitableTimerOpenWaitableTimer 函数返回此句柄。 句柄必须具有 TIMER_MODIFY_STATE 访问权限。 有关详细信息,请参阅 Synchronization Object Security and Access Rights

返回值

如果该函数成功,则返回值为非零值。

如果函数失败,则返回值为零。 要获得更多的错误信息,请调用 GetLastError。

注解

CancelWaitableTimer 函数不会更改计时器的信号状态。 它会先停止计时器,然后再将其设置为信号状态,并取消未完成的 APC。 因此,对计时器执行等待操作的线程将一直等待,直到它们超时或计时器重新激活,并且其状态设置为已发出信号。 如果计时器已处于已发出信号的状态,它将保持该状态。

若要重新激活计时器,请调用 SetWaitableTimer 函数。

若要编译使用此函数的应用程序, 请将_WIN32_WINNT 定义为 0x0400 或更高版本。 有关详细信息,请参阅 使用 Windows 标头

要求

要求
最低受支持的客户端 Windows XP [桌面应用 | UWP 应用]
最低受支持的服务器 Windows Server 2003 [桌面应用 | UWP 应用]
目标平台 Windows
标头 synchapi.h (包括 Windows Server 2003、Windows Vista、Windows 7、Windows Server 2008 Windows Server 2008 R2)
Library Kernel32.lib
DLL Kernel32.dll

另请参阅

CreateWaitableTimer

OpenWaitableTimer

SetWaitableTimer

同步函数

可等待计时器对象