Fonction CloseThreadpoolWait (threadpoolapiset.h)

Article
03/02/2024

Libère l’objet wait spécifié.

Syntaxe

void CloseThreadpoolWait(
  [in, out] PTP_WAIT pwa
);

Paramètres

[in, out] pwa

Pointeur vers une structure de TP_WAIT qui définit l’objet wait. La fonction CreateThreadpoolWait retourne ce pointeur.

Valeur de retour

None

Remarques

L’objet wait est libéré immédiatement s’il n’y a pas de rappels en attente ; sinon, l’objet minuteur est libéré de manière asynchrone une fois les rappels en suspens terminés.

Dans certains cas, les fonctions de rappel peuvent s’exécuter après l’appel de CloseThreadpoolWait . Pour éviter cela :

Appelez la fonction SetThreadpoolWait ou la fonction SetThreadpoolWaitEx avec le paramètre h défini sur NULL.
Appelez la fonction WaitForThreadpoolWaitCallbacks avec le paramètre fCancelPendingCallbacks défini sur TRUE.
Appelez CloseThreadpoolWait.

Si un groupe de nettoyage est associé à l’objet wait, il n’est pas nécessaire d’appeler cette fonction ; L’appel de la fonction CloseThreadpoolCleanupGroupMembers libère les objets de travail, d’attente et de minuteur associés au groupe de nettoyage.

Pour compiler une application qui utilise cette fonction, définissez _WIN32_WINNT comme 0x0600 ou une version ultérieure.

Exemples

Pour obtenir un exemple, consultez Utilisation des fonctions de pool de threads.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau \| applications UWP]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau \| applications UWP]
Plateforme cible	Windows
En-tête	threadpoolapiset.h (inclure Windows.h sur Windows 7, Windows Server 2008 Windows Server 2008 R2)
Bibliothèque	Kernel32.lib
DLL	Kernel32.dll