SetThreadpoolWaitEx-Funktion (threadpoolapiset.h)

Legt das Wait-Objekt fest, wobei ggf. das vorherige Wait-Objekt ersetzt wird. Ein Workerthread ruft die Rückruffunktion des Warteobjekts auf, nachdem das Handle signalisiert oder nach Ablauf des angegebenen Timeouts signalisiert wurde.

Syntax

BOOL SetThreadpoolWaitEx(
  [in, out]      PTP_WAIT  pwa,
  [in, optional] HANDLE    h,
  [in, optional] PFILETIME pftTimeout,
                 PVOID     Reserved
);

Die Parameter

[in, out] pwa

Ein Zeiger auf eine TP_WAIT Struktur, die das Wait-Objekt definiert. Die CreateThreadpoolWait-Funktion gibt diesen Zeiger zurück.

[in, optional] h

Ein Handle.

Wenn dieser Parameter NULL ist, wird das Wait-Objekt keine neuen Rückrufe mehr in die Warteschlange stellen (aber bereits in die Warteschlange eingereihte Rückrufe treten weiterhin auf).

Wenn dieser Parameter nicht NULL ist, muss er auf ein gültiges objekt mit Wartebarem verweisen.

Wenn dieses Handle geschlossen wird, während die Wartezeit noch aussteht, ist das Verhalten der Funktion nicht definiert. Wenn die Wartezeit noch aussteht und der Handle geschlossen werden muss, verwenden Sie CloseThreadpoolWait , um die Wartezeit abzubrechen und dann den Handle zu schließen.

Die Wartezeit wird als festgelegt betrachtet, wenn dieser Parameter nicht NULL ist.

[in, optional] pftTimeout

Ein Zeiger auf eine FILETIME-Struktur , die die absolute oder relative Zeit angibt, zu der der Wartezeitvorgang timeout sein soll. Wenn dieser Parameter auf einen positiven Wert verweist, gibt er die absolute Zeit seit dem 1. Januar 1601 (UTC) in 100-Nanosekundenintervallen an. Wenn dieser Parameter auf einen negativen Wert zeigt, gibt er den Zeitraum an, der relativ zur aktuellen Zeit gewartet werden soll. Wenn dieser Parameter auf Null zeigt, wird die Wartezeit sofort beendet. Weitere Informationen zu Zeitwerten finden Sie unter "File Times".

Wenn dieser Parameter NULL ist, wird kein Timeout für die Wartezeit ausgeführt.

Reserved

Reserviert Muss NULL sein.

Rückgabewert

Gibt TRUE zurück, wenn die Wartezeit zuvor festgelegt und abgebrochen wurde. Andernfalls wird FALSE zurückgegeben.

Wenn der vorherige Status der Wartezeit "festgelegt" war und die Funktion FALSE zurückgibt, wird ein Rückruf ausgeführt oder beginnt. Weitere Erläuterungen finden Sie in den Anmerkungen.

Bemerkungen

Ein Wait-Objekt kann nur auf ein Handle warten. Wenn Sie das Handle für ein Wait-Objekt festlegen, wird ggf. das vorherige Wartekästchen ersetzt.

In einigen Fällen können Rückruffunktionen ausgeführt werden, nachdem eine Anwendung den Threadpool-Timer geschlossen hat. Um dieses Verhalten zu verhindern, sollte eine Anwendung die in CloseThreadpoolWait beschriebenen Schritte ausführen.

Wenn das durch pftTimeout angegebene Timeout relativ ist, wird die Zeit, die das System im Ruhezustand oder im Ruhezustand verbringt, nicht auf den Ablauf der Wartezeit gezählt. Die Wartezeit wird signalisiert, wenn der kumulierte Zeitraum, den das System im Wachzustand verbringt, dem relativen Timeout der Wartezeit entspricht. Wenn das durch pftTimeout angegebene Timeout absolut ist, wird die Zeit, die das System im Ruhezustand oder im Ruhezustand verbringt, zum Ablauf der Wartezeit gezählt. Wenn die Wartezeit abläuft, während das System schläft, wird die Wartezeit sofort signalisiert, wenn das System aktiviert wird.

Anforderungen

Siehe auch

CloseThreadpoolWait

CreateThreadpoolWait

Threadpools

WaitForThreadpoolWaitCallbacks