Méthode IScheduledWorkItem ::SetIdleWait (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 .] ]

Définit les minutes pendant lesquelles le système doit être inactif avant que l’élément de travail puisse s’exécuter.

Syntaxe

HRESULT SetIdleWait(
  [in] WORD wIdleMinutes,
  [in] WORD wDeadlineMinutes
);

Paramètres

[in] wIdleMinutes

Valeur qui spécifie la durée pendant laquelle, en minutes, le système doit rester inactif avant que l’élément de travail puisse s’exécuter.

[in] wDeadlineMinutes

Valeur 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 SetIdleWait retourne S_OK.

Remarques

Le temps d’inactivité spécifié ici est utilisé conjointement avec les déclencheurs d’inactivité et lesconditions d’inactivité. Pour plus d’informations, consultez Conditions d’inactivité des tâches. Les déclencheurs inactifs sont des déclencheurs basés sur des événements qui ne sont pas associés à une heure planifiée. En revanche, les conditions d’inactivité sont associées à l’heure de début planifiée de la tâche.

Vous spécifiez des déclencheurs inactifs en définissant le membre TASK_TRIGGER_TYPE du TASK_TRIGGER sur TASK_EVENT_TRIGGER_ON_IDLE. Le déclencheur inactif est déclenché lorsque le système devient inactif pendant la durée spécifiée par wIdleMinutes.

Vous définissez 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 spécifiée par wIdleMinutes. Le service Planificateur de tâches attend jusqu’au nombre de minutes spécifié dans wDeadlineMinutes après l’heure de début planifiée pour voir si le système devient inactif.

Les applications doivent appeler la méthode IPersistFile ::Save après avoir appelé SetIdleWait pour mettre à jour l’intervalle d’attente inactif.

Exemples

Pour obtenir un exemple de définition du temps d’attente d’inactivité lors de la création d’un déclencheur inactif, consultez Création d’un exemple de déclencheur inactif.

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 ::GetIdleWait