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

Статья
02/29/2024

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

Задает флаги, которые изменяют поведение любого типа рабочего элемента.

Синтаксис

HRESULT SetFlags(
  DWORD dwFlags
);

Параметры

dwFlags

Значение типа , указывающее сочетание одного или нескольких следующих флагов:

TASK_FLAG_INTERACTIVE

Этот флаг используется при преобразовании Windows NT заданий службы AT в рабочие элементы. Задание службы Windows NT AT относится к At.exe— служебной программе командной строки Windows NT, используемой для создания заданий для службы Windows NT Schedule. Служба планировщика задач заменяет службу расписания и обратно совместима с ней. Преобразование происходит при установке планировщика задач в Windows NT или Windows 2000, например при установке Internet Обозреватель 4.0 или обновлении до Windows 2000. В процессе установки код установки планировщика задач ищет в реестре задания, созданные для службы AT, и создает рабочие элементы, которые будут выполнять ту же операцию.

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

TASK_FLAG_DELETE_WHEN_DONE

Рабочий элемент будет удален, если время выполнения больше не запланировано.

TASK_FLAG_DISABLED

Рабочий элемент отключен. Это полезно, чтобы временно предотвратить запуск рабочего элемента в запланированное время.

TASK_FLAG_HIDDEN

Созданный рабочий элемент будет скрыт.

TASK_FLAG_RUN_ONLY_IF_LOGGED_ON

Рабочий элемент выполняется только в том случае, если пользователь, указанный в IScheduledWorkItem::SetAccountInformation , вошел в систему в интерактивном режиме. Этот флаг не влияет на рабочие элементы, которые настроены для выполнения в локальной учетной записи.

TASK_FLAG_START_ONLY_IF_IDLE

Рабочий элемент начинается, только если компьютер не используется во время запланированного запуска.

TASK_FLAG_SYSTEM_REQUIRED

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

TASK_FLAG_KILL_ON_IDLE_END

Рабочий элемент завершает работу, если компьютер выполняет переход бездействия в режим бездействия во время работы рабочего элемента. Компьютер не считается бездействуемым до тех пор, пока IdleWait не активирует время без ввода данных пользователем. Сведения о триггерах простоя см. в разделе Триггер простоя.

TASK_FLAG_RESTART_ON_IDLE_RESUME

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

TASK_FLAG_DONT_START_IF_ON_BATTERIES

Рабочий элемент не запускается, если его целевой компьютер работает от батареи.

TASK_FLAG_KILL_IF_GOING_ON_BATTERIES

Рабочий элемент заканчивается, а связанное приложение завершает работу, если целевой компьютер рабочего элемента переключается на питание от батареи.

TASK_FLAG_RUN_IF_CONNECTED_TO_INTERNET

Рабочий элемент выполняется только при наличии допустимого подключения к Интернету.

Примечание В настоящее время эта функция не реализована.

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

Метод SetFlags возвращает одно из следующих значений.

Код возврата	Описание
S_OK	Операция выполнена успешно.
E_INVALIDARG	Недопустимые аргументы.
E_OUTOFMEMORY	Недостаточно памяти.

Этот метод используется для задания флагов, используемых любым типом запланированных рабочих элементов. В отличие от этого, ITask::SetTaskFlags используется только для задания флагов, используемых запланированными задачами.

Требования

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

IScheduledWorkItem::SetAccountInformation