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

Статья
08/25/2023

[[Этот API может быть изменен или недоступен в последующих версиях операционной системы или продукта. Вместо этого используйте интерфейсы планировщика задач 2.0 .] ]

Задает минуты, в течение в течение которым система должна находиться в режиме простоя перед запуском рабочего элемента .

Синтаксис

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

Параметры

[in] wIdleMinutes

Значение типа , указывающее, как долго (в минутах) система должна оставаться в состоянии простоя, прежде чем рабочий элемент сможет запуститься.

[in] wDeadlineMinutes

Значение типа , указывающее максимальное количество минут, в течение которых планировщик задач будет ожидать периода простоя, возвращаемого в pwIdleMinutes.

Возвращаемое значение

Метод SetIdleWait возвращает S_OK.

Указанное здесь время простоя используется в сочетании с триггерами простоя и условиями простоя. Дополнительные сведения см. в разделе Условия простоя задачи. Триггеры простоя — это триггеры на основе событий, которые не связаны с запланированным временем. Условия простоя, напротив, связаны с запланированным временем начала задачи.

Чтобы задать триггеры бездействия, задав TASK_EVENT_TRIGGER_ON_IDLE элементу TASK_TRIGGER_TYPE TASK_TRIGGER . Триггер простоя активируется, когда система простаивает в течение времени, указанного wIdleMinutes.

Условия простоя задаются путем вызова IScheduledWorkItem::SetFlags. Если установлен флаг TASK_FLAG_START_ONLY_IF_IDLE, рабочий элемент запускается в запланированное время, только если система простаивает в течение времени, указанного wIdleMinutes. Служба планировщика задач будет ожидать до количества минут, указанного в wDeadlineMinutes , после запланированного времени запуска, чтобы узнать, не простаивает ли система.

Приложения должны вызывать метод IPersistFile::Save после вызова SetIdleWait , чтобы обновить интервал ожидания бездействия.

Примеры

Пример установки времени ожидания бездействия при создании триггера простоя см. в разделе Пример создания триггера простоя.

Требования

Требование	Значение
Минимальная версия клиента	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::GetIdleWait