IScheduledWorkItem：：GetIdleWait 方法 (mstask.h)

  • 發行項

[[此 API 可能會在後續版本的操作系統或產品中變更或無法使用。 請改用 工作排程器 2.0 介面 。] ]

擷取工作項目的 閑置等候時間 。

如需閑置條件的相關信息，請參閱 工作閑置條件。

語法

HRESULT GetIdleWait(
  [out] WORD *pwIdleMinutes,
  [out] WORD *pwDeadlineMinutes
);

參數

[out] pwIdleMinutes

WORD 的指標，其中包含目前工作項目的閑置等候時間，以分鐘為單位。

[out] pwDeadlineMinutes

WORD 的指標，指定工作排程器等待 pwIdleMinutes 中傳回的空閒時間週期的最大分鐘數。

傳回值

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

傳回碼 描述
S_OK
 作業成功。
E_INVALIDARG
 自變數無效。

備註

此處傳回的空閒時間會與 閑置觸發 程式和 閑置條件搭配使用。 閑置觸發程式是與排程時間無關的事件型觸發程式。 閑置條件會與工作的排程開始時間相關聯。

閑置觸發程式是藉由將TASK_TRIGGER結構的TASK_TRIGGER_TYPE成員設定為值TASK_EVENT_TRIGGER_ON_IDLE來指定。 當系統在 pwIdleMinutes 中傳回的時間量閒置時，就會引發閒置觸發程式。

您可以呼叫 IScheduledWorkItem：：SetFlags 來設定閑置條件。 如果已設定TASK_FLAG_START_ONLY_IF_IDLE旗標，只有在系統在 pwIdleMinutes 中傳回的時間量閒置時，工作專案才會在其排程時間執行。 工作排程器服務會等候 pwDeadlineMinutes 超過排程的開始時間，以查看系統是否閒置。

範例

如需如何擷取工作閑置等候時間的範例，請參閱 C/C++ 程式代碼範例：擷取工作閑置等候時間。

規格需求

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

另請參閱

IScheduledWorkItem

IScheduledWorkItem：：SetIdleWait