IRegisteredTask::Run メソッド (taskschd.h)

登録されたタスクを直ちに実行します。

構文

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

[in] params

タスクアクションの値として使用されるパラメーター。タスクアクションにパラメーター値を指定しない場合は、このパラメーターを VT_NULL または VT_EMPTY に設定します。それ以外の場合は、単一 の BSTR 値または BSTR 値の配列を指定できます。

指定した BSTR 値は名前とペアになり、名前と値のペアとして格納されます。単一の BSTR 値を指定した場合、Arg0 は値に割り当てられた名前になります。この値は、アクションのプロパティで $(Arg0) 変数が使用されるタスクアクションで使用できます。

"0"、"100"、"250" などの値を BSTR 値の配列として渡すと、"0" は $(Arg0) 変数を置き換え、"100" は $(Arg1) 変数を置き換え、"250" はアクションプロパティで使用される $(Arg2) 変数を置き換えます。

最大 32 個の BSTR 値を指定できます。

値に $(Arg0)、$(Arg1)、...、$(Arg32) 変数を使用できるアクションプロパティの詳細と一覧については、「タスクアクション」を参照してください。

[out, optional] ppRunningTask

タスクの新しいインスタンスを定義する IRunningTask インターフェイス。

NULLIRunningTask インターフェイスポインターへの参照を渡します。 NULL 以外のポインターを参照すると、ポインターが上書きされるため、メモリリークが発生する可能性があります。

このメソッドは、成功すると S_OK を返します。そうでない場合は、HRESULT エラーコードを返します。

このメソッドはエラーなしでを返しますが、タスクの ITaskSettings の AllowDemandStart プロパティが false に設定されている場合、タスクは実行されません。

IRegisteredTask::Run 関数は IRegisteredTask::RunEx 関数に相当し、flags パラメーターは 0、user パラメーターは NULL です。

無効なタスクから IRegisteredTask::Run が呼び出されると、SCHED_E_TASK_DISABLEDが返されます。