Méthode IScheduledWorkItem ::GetStatus (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 la status de l’élément de travail.

Syntaxe

HRESULT GetStatus(
  [out] HRESULT *phrStatus
);

Paramètres

[out] phrStatus

Pointeur vers une valeur HRESULT qui contient l’une des valeurs suivantes au retour.

SCHED_S_TASK_READY

L’élément de travail est prêt à s’exécuter à l’heure planifiée suivante.

SCHED_S_TASK_RUNNING

L’élément de travail est en cours d’exécution.

SCHED_S_TASK_NOT_SCHEDULED

Une ou plusieurs des propriétés nécessaires à l’exécution de cette tâche selon une planification n’ont pas été définies.

SCHED_S_TASK_HAS_NOT_RUN

La tâche n’a pas été exécutée. Cette valeur est retournée chaque fois que la tâche n’a pas été exécutée, même si la tâche est prête à être exécutée à l’heure planifiée suivante ou si la tâche est une tâche périodique.

SCHED_S_TASK_DISABLED

La tâche ne s’exécutera pas aux heures planifiées, car elle a été désactivée.

SCHED_S_TASK_NO_MORE_RUNS

Il n’y a plus d’exécutions planifiées pour cette tâche.

SCHED_S_TASK_NO_VALID_TRIGGERS

La tâche n’a pas de déclencheurs ou les déclencheurs existants sont désactivés ou non définis.

Valeur retournée

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

Code de retour Description
S_OK
 L'opération a réussi. La demande a été envoyée. Pour plus d'informations, consultez la section Notes.
E_INVALIDARG
 Les arguments ne sont pas valides.

Remarques

Les méthodes de l’interface IScheduledWorkItem sont héritées par l’interface ITask . Par conséquent, IScheduledWorkItem ::GetStatus est généralement appelé via l’interface ITask .

IScheduledWorkItem ::GetStatus n’obtient pas dynamiquement le status de la tâche. ITaskScheduler ::Activate doit être appelé pour obtenir une nouvelle interface IScheduledWorkItem, qui est utilisée pour obtenir une status mise à jour. Pour plus d’informations, consultez l’exemple pour ITaskScheduler ::Activate.

Exemples

Pour obtenir un exemple de récupération des status d’une tâche, consultez Exemple de code C/C++ : récupération de l’état de la tâche.

Pour obtenir un exemple de récupération de la tâche status dans le cadre de l’arrêt de la tâche, consultez Exemple de fin de tâche.

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

Itask