Funzione CancelWaitableTimer (synchapi.h)

Articolo
03/13/2024

Imposta il timer waitable specificato sullo stato inattivo.

Sintassi

BOOL CancelWaitableTimer(
  [in] HANDLE hTimer
);

Parametri

[in] hTimer

Handle per l'oggetto timer. La funzione CreateWaitableTimer o OpenWaitableTimer restituisce questo handle. L'handle deve avere il diritto di accesso TIMER_MODIFY_STATE . Per altre informazioni, vedere Synchronization Object Security and Access Rights.For more information, see Synchronization Object Security and Access Rights.

Valore restituito

Se la funzione ha esito positivo, il valore restituito è diverso da zero.

Se la funzione ha esito negativo, il valore restituito è zero. Per informazioni dettagliate sull'errore, chiamare GetLastError.

Commenti

La funzione CancelWaitableTimer non modifica lo stato segnalato del timer. Arresta il timer prima che possa essere impostato sullo stato segnalato e annulla le API in sospeso. Di conseguenza, i thread che eseguono un'operazione di attesa sul timer rimangono in attesa fino a quando non si verifica il timeout o il timer viene riattivato e il relativo stato è impostato su segnalato. Se il timer è già nello stato segnalato, rimane in tale stato.

Per riattivare il timer, chiamare la funzione SetWaitableTimer .

Per compilare un'applicazione che usa questa funzione, definire _WIN32_WINNT come 0x0400 o versione successiva. Per altre informazioni, vedere Uso delle intestazioni di Windows.

Requisiti

Requisito	Valore
Client minimo supportato	Windows XP [app desktop \| App UWP]
Server minimo supportato	Windows Server 2003 [app desktop \| App UWP]
Piattaforma di destinazione	Windows
Intestazione	synchapi.h (include Windows.h in Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 Windows Server 2008 R2)
Libreria	Kernel32.lib
DLL	Kernel32.dll