Метод IScheduledWorkItem::GetIdleWait (mstask.h)

Статья
08/25/2023

[[Этот 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_TYPE элементу структуры TASK_TRIGGER значения 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
Header	mstask.h
Библиотека	Mstask.lib
DLL	Mstask.dll
Распространяемые компоненты	Internet Обозреватель 4.0 или более поздней версии в Windows NT 4.0 и Windows 95

См. также раздел

IScheduledWorkItem

IScheduledWorkItem::SetIdleWait

Share via