CancelWaitableTimer 函式 (synchapi.h)

將指定的可等候定時器設定為非使用中狀態。

語法

BOOL CancelWaitableTimer(
  [in] HANDLE hTimer
);

[in] hTimer

定時器物件的句柄。 CreateWaitableTimer 或 OpenWaitableTimer 函式會傳回此句柄。句柄必須具有 TIMER_MODIFY_STATE 訪問許可權。如需詳細資訊，請參閱同步處理物件安全性和訪問許可權。

如果函式成功，則傳回非零的值。

如果此函式失敗，則傳回值為零。若要取得擴充的錯誤資訊，請呼叫 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)
程式庫	Kernel32.lib
DLL	Kernel32.dll