IScheduledWorkItem::SetIdleWait 方法 (mstask.h)

[[此 API 可能在操作系统或产品的后续版本中更改或不可用。 请改用 任务计划程序 2.0 接口 。] ]

设置系统在 工作项 可以运行之前必须处于空闲状态的分钟数。

语法

HRESULT SetIdleWait(
  [in] WORD wIdleMinutes,
  [in] WORD wDeadlineMinutes
);

参数

[in] wIdleMinutes

一个 值,该值指定系统在工作项可以运行之前必须保持空闲状态的时间(以分钟为单位)。

[in] wDeadlineMinutes

一个 值,该值指定任务计划程序等待 pwIdleMinutes 中返回的空闲时间段的最大分钟数。

返回值

SetIdleWait 方法返回S_OK。

注解

此处指定的空闲时间与 空闲触发器空闲条件结合使用。 有关详细信息,请参阅 任务空闲条件。 空闲触发器是基于事件的触发器,不与计划时间相关联。 相比之下,空闲条件与任务的计划开始时间相关联。

通过将TASK_TRIGGER TASK_TRIGGER_TYPE 成员设置为TASK_EVENT_TRIGGER_ON_IDLE 来指定空闲触发器。 当系统空闲的时间达到 wIdleMinutes 指定的时间量时,将触发空闲触发器。

通过调用 IScheduledWorkItem::SetFlags 来设置空闲条件。 如果设置了TASK_FLAG_START_ONLY_IF_IDLE标志,则仅当系统在 wIdleMinutes 指定的时间内处于空闲状态时,工作项才会在其计划时间运行。 任务计划程序服务将等待 wDeadlineMinutes 中指定的分钟数超过计划的开始时间,以查看系统是否变为空闲状态。

应用程序必须在调用 SetIdleWait 后调用 IPersistFile::Save 方法以更新空闲等待间隔。

示例

有关如何在创建空闲触发器时设置空闲等待时间的示例,请参阅 创建空闲触发器示例

要求

要求
最低受支持的客户端 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 或更高版本

另请参阅

IScheduledWorkItem

IScheduledWorkItem::GetIdleWait