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

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

構文

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

[in] params

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

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

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

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

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

[out, optional] ppRunningTask

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

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

このメソッドが成功した場合は、S_OKを返します。それ以外の場合は、HRESULT エラーコードが返されます。

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

IRegisteredTask::Run 関数は、IRegisteredTask::RunEx 関数と同じです。フラグパラメーターは 0 で、ユーザーパラメーターは null等しくなります。

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