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

尚未設定一或多個依排程執行這項工作所需的屬性。

SCHED_S_TASK_HAS_NOT_RUN

工作尚未執行。 每當工作尚未執行時，就會傳回這個值，即使工作已準備好在下一個排程時間執行，或工作是週期性工作也一樣。

SCHED_S_TASK_DISABLED

工作不會在排程時間執行，因為它已停用。

SCHED_S_TASK_NO_MORE_RUNS

此工作不會再排程執行。

SCHED_S_TASK_NO_VALID_TRIGGERS

工作沒有觸發程式，或已停用或未設定現有的觸發程式。

傳回值

GetStatus 方法會傳回下列其中一個值。

傳回碼	描述
S_OK	作業成功。 已傳送要求。 如需詳細資訊，請參閱＜備註＞。
E_INVALIDARG	自變數無效。

備註

IScheduledWorkItem 介面的方法會由ITask介面繼承。 因此， IScheduledWorkItem：：GetStatus 通常會透過 ITask 介面呼叫。

IScheduledWorkItem：：GetStatus 不會動態取得工作的狀態。 應該呼叫 ITaskScheduler：：Activate 以取得新的 IScheduledWorkItem 介面，用來取得更新的狀態。 如需詳細資訊，請參閱 ITaskScheduler：：Activate 的範例。

範例

如需如何擷取工作狀態的範例，請參閱 C/C++ 程式代碼範例：擷取工作狀態。

如需如何在終止工作時擷取工作狀態的範例，請參閱 終止工作範例。

規格需求

需求	值
最低支援的用戶端	Windows 2000 專業版 [僅限傳統型應用程式]
最低支援的伺服器	Windows 2000 Server [僅限傳統型應用程式]
目標平台	Windows
標頭	mstask.h
程式庫	Mstask.lib
Dll	Mstask.dll
可轉散發套件	Windows NT 4.0 和 Windows 95 上的 Internet Explorer 4.0 或更新版本

另請參閱

IScheduledWorkItem

ITask