Méthode IScheduledWorkItem ::SetFlags (mstask.h)
[[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 indicateurs qui modifient le comportement de tout type d’élément de travail.
Syntaxe
HRESULT SetFlags(
DWORD dwFlags
);
Paramètres
dwFlags
Valeur qui spécifie une combinaison d’un ou plusieurs des indicateurs suivants :
TASK_FLAG_INTERACTIVE
Cet indicateur est utilisé lors de la conversion des travaux de service Windows NT AT en éléments de travail. Le travail de service Windows NT AT fait référence à At.exe, l’utilitaire de ligne de commande Windows NT utilisé pour la création de travaux pour le service De planification Windows NT. Le service Planificateur de tâches remplace le service Schedule et est rétrocompatible avec celui-ci. La conversion se produit lorsque le planificateur de tâches est installé sur Windows NT/Windows 2000, par exemple, si vous installez Internet Explorer 4.0 ou si vous effectuez une mise à niveau vers Windows 2000. Pendant le processus d’installation, le code d’installation du planificateur de tâches recherche dans le Registre les travaux créés pour le service AT et crée des éléments de travail qui effectuent la même opération.
Pour ces travaux convertis, l’indicateur interactif est défini si l’élément de travail est destiné à être affiché à l’utilisateur. Lorsque cet indicateur n’est pas défini, aucun élément de travail n’est affiché dans le dossier Tâches et aucune interface utilisateur associée à l’élément de travail n’est présentée à l’utilisateur lors de l’exécution de l’élément de travail.
TASK_FLAG_DELETE_WHEN_DONE
L’élément de travail est supprimé lorsqu’il n’y a plus d’heures d’exécution planifiées.
TASK_FLAG_DISABLED
L’élément de travail est désactivé. Cela est utile pour empêcher temporairement l’exécution d’un élément de travail aux heures planifiées.
TASK_FLAG_HIDDEN
L’élément de travail créé sera masqué.
TASK_FLAG_RUN_ONLY_IF_LOGGED_ON
L’élément de travail s’exécute uniquement si l’utilisateur spécifié dans IScheduledWorkItem ::SetAccountInformation est connecté de manière interactive. Cet indicateur n’a aucun effet sur les éléments de travail qui sont définis pour s’exécuter dans le compte local.
TASK_FLAG_START_ONLY_IF_IDLE
L’élément de travail commence uniquement si l’ordinateur n’est pas en cours d’utilisation à l’heure de début planifiée.
TASK_FLAG_SYSTEM_REQUIRED
L’élément de travail entraîne la reprise ou le réveil du système si le système fonctionne sur batterie. Cet indicateur est pris en charge uniquement sur les systèmes qui prennent en charge les minuteurs de CV.
TASK_FLAG_KILL_ON_IDLE_END
L’élément de travail se termine si l’ordinateur effectue une transition inactif vers non inactif pendant l’exécution de l’élément de travail. L’ordinateur n’est pas considéré comme inactif tant que le temps des déclencheurs IdleWait ne s’est pas écoulé sans aucune entrée utilisateur. Pour plus d’informations sur les déclencheurs inactifs, consultez Déclencheur d’inactivité.
TASK_FLAG_RESTART_ON_IDLE_RESUME
L’élément de travail redémarre si l’ordinateur effectue une transition non inactive vers inactif avant que tous les task_triggers de l’élément de travail s’écoulent. (Utilisez cet indicateur conjointement avec TASK_FLAG_KILL_ON_IDLE_END.)
TASK_FLAG_DONT_START_IF_ON_BATTERIES
L’élément de travail ne démarre pas si son ordinateur cible fonctionne sur batterie.
TASK_FLAG_KILL_IF_GOING_ON_BATTERIES
L’élément de travail se termine et l’application associée se ferme si l’ordinateur cible de l’élément de travail passe à l’alimentation de la batterie.
TASK_FLAG_RUN_IF_CONNECTED_TO_INTERNET
L’élément de travail s’exécute uniquement s’il existe actuellement une connexion Internet valide.
Valeur retournée
La méthode SetFlags retourne l’une des valeurs suivantes.
| Code de retour | Description |
|---|---|
|
L'opération a réussi. |
|
Les arguments ne sont pas valides. |
|
Mémoire disponible insuffisante. |
Remarques
Les programmes doivent appeler la méthode IPersistFile ::Save après avoir appelé SetFlags pour mettre à jour les indicateurs.
Cette méthode est utilisée pour définir les indicateurs utilisés par n’importe quel type d’élément de travail planifié. En revanche, ITask ::SetTaskFlags est utilisé uniquement pour définir les indicateurs utilisés par les tâches planifiées.
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 |