Метод 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++ Code Example: Retrieving Task Status.
Пример получения состояния задачи в рамках завершения задачи см. в разделе Пример завершения задачи.
Требования
Требование | Значение |
---|---|
Минимальная версия клиента | Windows 2000 Professional [только классические приложения] |
Минимальная версия сервера | Windows 2000 Server [только классические приложения] |
Целевая платформа | Windows |
Header | mstask.h |
Библиотека | Mstask.lib |
DLL | Mstask.dll |
Распространяемые компоненты | Internet Обозреватель 4.0 или более поздней версии в Windows NT 4.0 и Windows 95 |