IScheduledWorkItem::GetStatus メソッド (mstask.h)

[[この API は、以降のバージョンのオペレーティング システムまたは製品で変更または使用できない場合があります。 代わりに タスク スケジューラ 2.0 インターフェイス を使用してください。] ]

作業項目の状態を取得します。

構文

HRESULT GetStatus(
  [out] HRESULT *phrStatus
);

パラメーター

[out] phrStatus

戻り値として次のいずれかの値を含む HRESULT 値へのポインター。

SCHED_S_TASK_READY

作業項目は、次にスケジュールされた時刻に実行する準備ができています。

SCHED_S_TASK_RUNNING

作業項目は現在実行中です。

SCHED_S_TASK_NOT_SCHEDULED

スケジュールに従ってこのタスクを実行するために必要な 1 つ以上のプロパティが設定されていません。

SCHED_S_TASK_HAS_NOT_RUN

タスクが実行されていません。 この値は、タスクが次にスケジュールされた時刻に実行する準備ができているか、タスクが定期的なタスクである場合でも、タスクが実行されていない場合に常に返されます。

SCHED_S_TASK_DISABLED

タスクは無効になっているため、スケジュールされた時刻には実行されません。

SCHED_S_TASK_NO_MORE_RUNS

このタスクに対してスケジュールされた実行はこれ以上ありません。

SCHED_S_TASK_NO_VALID_TRIGGERS

タスクにトリガーがないか、既存のトリガーが無効になっているか、設定されていません。

戻り値

GetStatus メソッドは、次のいずれかの値を返します。

注釈

IScheduledWorkItem インターフェイスのメソッドは、ITask インターフェイスによって継承されます。 そのため、 IScheduledWorkItem::GetStatus は通常 、ITask インターフェイスを介して呼び出されます。

IScheduledWorkItem::GetStatus は、タスクの状態を動的に取得しません。 ITaskScheduler::Activate を呼び出して、更新された状態を取得するために使用される新しい IScheduledWorkItem インターフェイスを取得する必要があります。 詳細については、 ITaskScheduler::Activate の例を参照してください。

例

タスクの状態を取得する方法の例については、「 C/C++ コード例: タスクの状態の取得」を参照してください。

タスクの終了の一環としてタスクの状態を取得する方法の例については、「タスクの 終了の例」を参照してください。

要件

こちらもご覧ください

IScheduledWorkItem

Itask