CancelWaitableTimer, fonction (synchapi.h)

Article
03/04/2024

Définit le minuteur d’attente spécifié à l’état inactif.

Syntaxe

BOOL CancelWaitableTimer(
  [in] HANDLE hTimer
);

Paramètres

[in] hTimer

Handle de l’objet minuteur. La fonction CreateWaitableTimer ou OpenWaitableTimer retourne ce handle. Le handle doit avoir le droit d’accès TIMER_MODIFY_STATE . Pour plus d’informations, consultez Synchronisation des droits d’accès et de sécurité des objets.

Valeur retournée

Si la fonction réussit, la valeur de retour est différente de zéro.

Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

Remarques

La fonction CancelWaitableTimer ne modifie pas l’état signalé du minuteur. Il arrête le minuteur avant de pouvoir être défini sur l’état signalé et annule les API en attente. Par conséquent, les threads effectuant une opération d’attente sur le minuteur restent en attente jusqu’à ce qu’ils expirent ou que le minuteur soit réactivé et que son état soit défini sur signalé. Si le minuteur est déjà dans l’état signalé, il reste dans cet état.

Pour réactiver le minuteur, appelez la fonction SetWaitableTimer .

Pour compiler une application qui utilise cette fonction, définissez _WIN32_WINNT comme 0x0400 ou version ultérieure. Pour plus d’informations, consultez Utilisation des en-têtes Windows.

Configuration requise

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