iScheduledWorkItem：：GetIdleWait 方法 (mstask.h)
[[此 API 可能在操作系统或产品的后续版本中更改或不可用。 请改用 任务计划程序 2.0 接口 。] ]
检索工作项的 空闲等待时间 。
有关空闲条件的信息，请参阅 任务空闲条件。
语法
HRESULT GetIdleWait(
[out] WORD *pwIdleMinutes,
[out] WORD *pwDeadlineMinutes
);
参数
[out] pwIdleMinutes
指向 WORD 的指针，该 WORD 包含当前工作项的空闲等待时间（以分钟为单位）。
[out] pwDeadlineMinutes
指向 WORD 的指针，指定任务计划程序等待 pwIdleMinutes 中返回的空闲时间段的最大分钟数。
返回值
GetIdleWait 方法返回以下值之一。
| 返回代码 | 说明 |
|---|---|
|
操作成功。 |
|
参数无效。 |
注解
此处返回的空闲时间与 空闲触发器 和 空闲条件结合使用。 空闲触发器是基于事件的触发器，不与计划时间相关联。 空闲条件与任务的计划开始时间相关联。
通过将 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 |
| Library | Mstask.lib |
| DLL | Mstask.dll |
| 可再发行组件 | Windows NT 4.0 和 Windows 95 上的 Internet Explorer 4.0 或更高版本 |