CloseThreadpoolTimer, fonction (threadpoolapiset.h)

Article
03/04/2024

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

Syntaxe

void CloseThreadpoolTimer(
  [in, out] PTP_TIMER pti
);

Paramètres

[in, out] pti

Pointeur vers TP_TIMER structure qui définit l’objet minuteur. La fonction CreateThreadpoolTimer retourne ce pointeur.

Valeur de retour

None

Remarques

L’objet minuteur est libéré immédiatement s’il n’y a aucun rappel en attente ; sinon, l’objet minuteur est libéré de façon asynchrone une fois les fonctions de rappel en attente terminées.

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

Appelez la fonction SetThreadpoolTimer ou la fonction SetThreadpoolTimerEx avec le paramètre pftDueTime défini sur NULL et les paramètres msPeriod et msWindowLength définis sur 0.
Appelez la fonction WaitForThreadpoolTimerCallbacks avec le paramètre fCancelPendingCallbacks défini sur TRUE.
Appelez CloseThreadpoolTimer.

S’il existe un groupe de nettoyage associé à l’objet minuteur, 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.

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