DeleteTimerQueueEx-Funktion (threadpoollegacyapiset.h)

Artikel
03/02/2024

Löscht eine Timerwarteschlange. Alle ausstehenden Timer in der Warteschlange werden abgebrochen und gelöscht.

Syntax

BOOL DeleteTimerQueueEx(
  [in]           HANDLE TimerQueue,
  [in, optional] HANDLE CompletionEvent
);

Parameter

[in] TimerQueue

Ein Handle für die Zeitgeberwarteschlange. Dieses Handle wird von der CreateTimerQueue-Funktion zurückgegeben.

[in, optional] CompletionEvent

Ein Handle für das Ereignisobjekt, das signalisiert werden soll, wenn die Funktion erfolgreich ist und alle Rückruffunktionen abgeschlossen wurden. Dieser Parameter kann NULL sein.

Wenn dieser Parameter INVALID_HANDLE_VALUE ist, wartet die Funktion, bis alle Rückruffunktionen abgeschlossen sind, bevor sie zurückgegeben wird.

Wenn dieser Parameter NULL ist, markiert die Funktion den Timer für das Löschen und gibt sofort zurück. Die meisten Aufrufer sollten jedoch warten, bis die Rückruffunktion abgeschlossen ist, damit sie alle erforderlichen Bereinigungen durchführen können.

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

Führen Sie keine blockierenden Aufrufe von DeleteTimerQueueEx innerhalb eines Timerrückrufs aus.

Um eine Anwendung zu kompilieren, die diese Funktion verwendet, definieren Sie _WIN32_WINNT als 0x0500 oder höher. Weitere Informationen finden Sie unter Verwenden der Windows-Header.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	threadpoollegacyapiset.h
Bibliothek	Kernel32.lib
DLL	Kernel32.dll