Fonction ChangeTimerQueueTimer (threadpoollegacyapiset.h)

Article
08/26/2023

Mises à jour un minuteur-file d’attente créé par la fonction CreateTimerQueueTimer.

Syntaxe

BOOL ChangeTimerQueueTimer(
  [in, optional] HANDLE TimerQueue,
  [in, out]      HANDLE Timer,
  [in]           ULONG  DueTime,
  [in]           ULONG  Period
);

Paramètres

[in, optional] TimerQueue

Handle de la file d’attente du minuteur. Ce handle est retourné par la fonction CreateTimerQueue .

Si ce paramètre a la valeur NULL, le minuteur est associé à la file d’attente du minuteur par défaut.

[in, out] Timer

Handle du minuteur-file d’attente. Ce handle est retourné par la fonction CreateTimerQueueTimer .

[in] DueTime

Durée après laquelle le minuteur doit expirer, en millisecondes.

[in] Period

Période du minuteur, en millisecondes. Si ce paramètre est égal à zéro, le minuteur est signalé une fois. Si ce paramètre est supérieur à zéro, le minuteur est périodique. Un minuteur périodique se réactive automatiquement chaque fois que la période s’écoule, jusqu’à ce que le minuteur soit annulé à l’aide de la fonction DeleteTimerQueueTimer ou réinitialisé à l’aide de ChangeTimerQueueTimer.

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

Cette fonction ne peut pas être appelée lorsque le thread utilise l’emprunt d’identité. Le comportement résultant n’est pas défini.

Vous pouvez appeler ChangeTimerQueueTimer dans un rappel du minuteur.

Si vous appelez ChangeTimerQueueTimer sur un minuteur one-shot (sa période est égale à zéro) qui a déjà expiré, le minuteur n’est pas mis à jour.

N’appelez pas ChangeTimerQueueTimer après avoir appelé DeleteTimerQueueTimer sur un handle.

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

Configuration requise


Client minimal pris en charge	Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	threadpoollegacyapiset.h
Bibliothèque	Kernel32.lib
DLL	Kernel32.dll