CancelWaitableTimer-Funktion (synchapi.h)
Legt den angegebenen wartebaren Timer auf den inaktiven Zustand fest.
Syntax
BOOL CancelWaitableTimer(
[in] HANDLE hTimer
);
Parameter
[in] hTimer
Ein Handle für das Timerobjekt. Die Funktion CreateWaitableTimer oder OpenWaitableTimer gibt dieses Handle zurück. Das Handle muss über das zugriffsrecht TIMER_MODIFY_STATE verfügen. Weitere Informationen finden Sie unter Synchronisierungsobjektsicherheit und Zugriffsrechte.
Rückgabewert
Wenn die Funktion erfolgreich ist, ist der Rückgabewert ungleich Null.
Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.
Hinweise
Die CancelWaitableTimer-Funktion ändert den Signalzustand des Timers nicht. Er beendet den Timer, bevor er auf den signalierten Zustand eingestellt werden kann, und bricht ausstehende APCs ab. Daher warten Threads, die einen Wartevorgang auf dem Timer ausführen, bis sie ein Timeout ausführen oder der Timer reaktiviert wird und sein Zustand auf Signal festgelegt ist. Wenn sich der Timer bereits im signalierten Zustand befindet, bleibt er in diesem Zustand.
Um den Timer erneut zu aktivieren, rufen Sie die SetWaitableTimer-Funktion auf.
Um eine Anwendung zu kompilieren, die diese Funktion verwendet, definieren Sie _WIN32_WINNT als 0x0400 oder höher. Weitere Informationen finden Sie unter Verwenden der Windows-Header.
Anforderungen
Anforderung | Wert |
---|---|
Unterstützte Mindestversion (Client) | Windows XP [Desktop-Apps | UWP-Apps] |
Unterstützte Mindestversion (Server) | Windows Server 2003 [Desktop-Apps | UWP-Apps] |
Zielplattform | Windows |
Kopfzeile | synchapi.h (einschließlich Windows.h unter Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 Windows Server 2008 R2) |
Bibliothek | Kernel32.lib |
DLL | Kernel32.dll |