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 方法返回以下值之一。
返回代码 | 说明 |
---|---|
|
操作成功。 请求已发送。 有关详细信息,请参阅“备注”。 |
|
参数无效。 |
注解
IScheduledWorkItem 接口的方法由 ITask 接口继承。 因此, IScheduledWorkItem::GetStatus 通常通过 ITask 接口调用。
IScheduledWorkItem::GetStatus 不会动态获取任务的状态。 应调用 ITaskScheduler::Activate 以获取用于获取更新状态的新 IScheduledWorkItem 接口。 有关详细信息,请参阅 ITaskScheduler::Activate 的示例。
示例
有关如何检索任务状态的示例,请参阅 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 或更高版本 |