Share via

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

  • [アーティクル]

指定したフラグとセッション識別子を使用して、登録されたタスクを直ちに実行します。

構文

HRESULT RunEx(
  [in]            VARIANT      params,
  [in]            LONG         flags,
  [in]            LONG         sessionID,
  [in]            BSTR         user,
  [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) 変数を使用できるアクション プロパティの詳細と一覧については、「 タスク アクション」を参照してください。

[in] flags

タスク の 実行方法を定義するTASK_RUN_FLAGS定数。

[in] sessionID

タスクを開始するターミナル サーバー セッション。

TASK_RUN_USE_SESSION_ID定数が flags パラメーターに渡されない場合、このパラメーターで指定された値は無視されます。 TASK_RUN_USE_SESSION_ID定数が flags パラメーターに渡され、sessionID 値が 0 以下の場合は、無効な引数エラーが返されます。

TASK_RUN_USE_SESSION_ID定数が flags パラメーターに渡され、sessionID 値が 0 より大きい有効なセッション ID であり、ユーザー パラメーターに値が指定されていない場合、タスク スケジューラ サービスは、指定されたセッションにログオンしているユーザーとして対話形式でタスクを開始しようとします。

TASK_RUN_USE_SESSION_ID定数が flags パラメーターに渡され、sessionID 値が 0 より大きい有効なセッション ID であり、ユーザーが user パラメーターで指定されている場合、タスク スケジューラ サービスは、ユーザー パラメーターで指定されたユーザーとして対話形式でタスクを開始しようとします。

[in] user

タスクを実行するユーザー。

[out, optional] ppRunningTask

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

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

戻り値

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

解説

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

無効なタスクから IRegisteredTask::RunEx が呼び出されると、S_OKが返されますが、タスクは実行されません。

要件

   
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー taskschd.h
Library Taskschd.lib
[DLL] Taskschd.dll

関連項目

IRegisteredTask

タスク スケジューラ