Méthode IScheduledWorkItem ::GetIdleWait (mstask.h)

  • Article

[[Cette API peut être modifiée ou indisponible dans les versions ultérieures du système d’exploitation ou du produit. Utilisez plutôt les interfaces Du planificateur de tâches 2.0 .] ]

Récupère le temps d’attente d’inactivité de l’élément de travail.

Pour plus d’informations sur les conditions d’inactivité, consultez Conditions d’inactivité des tâches.

Syntaxe

HRESULT GetIdleWait(
  [out] WORD *pwIdleMinutes,
  [out] WORD *pwDeadlineMinutes
);

Paramètres

[out] pwIdleMinutes

Pointeur vers un MOT qui contient le temps d’attente d’inactivité de l’élément de travail actuel, en minutes.

[out] pwDeadlineMinutes

Pointeur vers un MOT qui spécifie le nombre maximal de minutes pendant lesquelles le planificateur de tâches attendra la période d’inactivité retournée dans pwIdleMinutes.

Valeur retournée

La méthode GetIdleWait retourne l’une des valeurs suivantes.

Code de retour Description
S_OK
 L'opération a réussi.
E_INVALIDARG
 Les arguments ne sont pas valides.

Remarques

Le temps d’inactivité retourné ici est utilisé conjointement avec les déclencheurs d’inactivité et lesconditions d’inactivité. Les déclencheurs inactifs sont des déclencheurs basés sur des événements qui ne sont pas associés à une heure planifiée. Les conditions d’inactivité sont associées à l’heure de début planifiée de la tâche.

Les déclencheurs inactifs sont spécifiés en définissant le membre TASK_TRIGGER_TYPE de la structure TASK_TRIGGER sur la valeur TASK_EVENT_TRIGGER_ON_IDLE. Le déclencheur inactif est déclenché lorsque le système devient inactif pendant la durée retournée dans pwIdleMinutes.

Vous pouvez définir des conditions d’inactivité en appelant IScheduledWorkItem ::SetFlags. Si l’indicateur TASK_FLAG_START_ONLY_IF_IDLE est défini, l’élément de travail s’exécute à son heure planifiée uniquement si le système devient inactif pendant la durée retournée dans pwIdleMinutes. Le service Planificateur de tâches attend jusqu’à pwDeadlineMinutes au-delà de l’heure de début planifiée pour voir si le système devient inactif.

Exemples

Pour obtenir un exemple de récupération du temps d’inactivité d’une tâche, consultez Exemple de code C/C++ : Récupération du temps d’inactivité des tâches.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge Windows 2000 Server [applications de bureau uniquement]
Plateforme cible Windows
En-tête mstask.h
Bibliothèque Mstask.lib
DLL Mstask.dll
Composant redistribuable Internet Explorer 4.0 ou version ultérieure sur Windows NT 4.0 et Windows 95

Voir aussi

IScheduledWorkItem

IScheduledWorkItem ::SetIdleWait