Partager via


Méthode IRegisteredTask::Run (taskschd.h)

Exécute immédiatement la tâche inscrite.

Syntaxe

HRESULT Run(
  [in]            VARIANT      params,
  [out, optional] IRunningTask **ppRunningTask
);

Paramètres

[in] params

Paramètres utilisés comme valeurs dans les actions de tâche. Pour ne spécifier aucune valeur de paramètre pour les actions de tâche, définissez ce paramètre sur VT_NULL ou VT_EMPTY. Sinon, une seule valeur BSTR ou un tableau de valeurs BSTR peuvent être spécifiés.

Les valeurs BSTR que vous spécifiez sont associées à des noms et stockées sous forme de paires nom-valeur. Si vous spécifiez une seule valeur BSTR , Arg0 sera le nom attribué à la valeur. La valeur peut être utilisée dans l’action de tâche où la variable $(Arg0) est utilisée dans les propriétés de l’action.

Si vous transmettez des valeurs telles que « 0 », « 100 » et « 250 » en tant que tableau de valeurs BSTR , « 0 » remplace les variables $(Arg0), « 100 » remplace les variables $(Arg1) et « 250 » remplace les variables $(Arg2) utilisées dans les propriétés d’action.

Un maximum de 32 valeurs BSTR peut être spécifié.

Pour plus d’informations et pour obtenir la liste des propriétés d’action qui peuvent utiliser les variables $(Arg0), $(Arg1), ..., $(Arg32) dans leurs valeurs, consultez Actions de tâche.

[out, optional] ppRunningTask

Interface IRunningTask qui définit la nouvelle instance de la tâche.

Transmettez une référence à un pointeur d’interface IRunningTaskNULL. Le référencement d’un pointeur non NULL peut provoquer une fuite de mémoire, car le pointeur sera remplacé.

Valeur retournée

Si cette méthode réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.

Remarques

Cette méthode retourne sans erreur, mais la tâche ne s’exécute pas si la propriété AllowDemandStart de ITaskSettings est définie sur false pour la tâche.

La fonction IRegisteredTask::Run est équivalente à la fonction IRegisteredTask::RunEx avec le paramètre flags égal à 0 et le paramètre utilisateur égal à NULL.

Si IRegisteredTask::Run est appelé à partir d’une tâche désactivée, il retourne SCHED_E_TASK_DISABLED.

Configuration requise

   
Client minimal pris en charge Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2008 [applications de bureau uniquement]
Plateforme cible Windows
En-tête taskschd.h
Bibliothèque Taskschd.lib
DLL Taskschd.dll

Voir aussi

IRegisteredTask

Planificateur de tâches