IRegisteredTask ::Run, méthode (taskschd.h)

Article
07/16/2024

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 pas spécifier de valeurs de paramètre pour les actions de tâche, définissez ce paramètre sur VT_NULL ou VT_EMPTY. Sinon, une valeur BSTR unique ou un tableau de valeurs BSTR peuvent être spécifiées.

Les valeurs BSTR que vous spécifiez sont jumelées avec des noms et stockées en tant que paires nom-valeur. Si vous spécifiez une 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 d’action.

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

Une valeur maximale de 32 valeurs de BSTR peut être spécifiée.

Pour plus d’informations et une liste de propriétés d’action qui peuvent utiliser $(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.

Passez une référence à un pointeur d’interface NULLIRunningTask. Le référencement d’un pointeur NULL nonpeut provoquer une fuite de mémoire, car le pointeur sera remplacé.

Valeur de retour

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

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 équivaut à la fonction IRegisteredTask ::RunEx avec le paramètre d’indicateurs é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.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows Vista [applications de bureau uniquement]
serveur minimum pris en charge	Windows Server 2008 [applications de bureau uniquement]
plateforme cible	Windows
d’en-tête	taskschd.h
bibliothèque	Taskschd.lib
DLL	Taskschd.dll

Voir aussi

IRegisteredTask

planificateur de tâches

Partager via