Метод IRegisteredTask::Run (taskschd.h)

Статья
07/16/2024

Выполняет зарегистрированную задачу немедленно.

Синтаксис

HRESULT Run(
  [in]            VARIANT      params,
  [out, optional] IRunningTask **ppRunningTask
);

Параметры

[in] params

Параметры, используемые в качестве значений в действиях задачи. Чтобы не указывать значения параметров для действий задачи, задайте для этого параметра значение VT_NULL или VT_EMPTY. В противном случае можно указать одно значение BSTR или массив значений BSTR.

Указанные значения BSTR BSTR связаны с именами и хранятся в виде пар "имя-значение". Если указать одно значение BSTR, то Arg0 будет именем, назначенным значению. Значение можно использовать в действии задачи, где переменная $(Arg0) используется в свойствах действия.

Если вы передаете такие значения, как "0", "100" и "250" в виде массива значений BSTR , то "0" заменит переменные $(Arg0), "100" заменит переменные $(Arg1) и "250" заменит переменные $(Arg2), которые используются в свойствах действия.

Можно указать не более 32 значений BSTR.

Дополнительные сведения и список свойств действий, которые могут использовать переменные $(Arg0), $(Arg1), ..., $(Arg32) в их значениях, см. в действий задач.

[out, optional] ppRunningTask

Интерфейс IRunningTask, определяющий новый экземпляр задачи.

Передайте ссылку на указатель интерфейса NULLIRunningTask. Ссылка на указатель, неNULL может привести к утечке памяти, так как указатель будет перезаписан.

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

Если этот метод выполнен успешно, он возвращает S_OK. В противном случае возвращается код ошибки HRESULT.

Замечания

Этот метод возвращается без ошибок, но задача не будет выполняться, если свойство AllowDemandStart ITaskSettings имеет значение false для задачи.

Функция IRegisteredTask::Run эквивалентна функции IRegisteredTask::RunEx с параметром флагов равным 0, а параметр пользователя равен NULL.

Если IRegisteredTask::Run вызывается из отключенной задачи, он вернет SCHED_E_TASK_DISABLED.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows Vista [только классические приложения]
минимальный поддерживаемый сервер	Windows Server 2008 [только классические приложения]
целевая платформа	Виндоус
заголовка	taskschd.h
библиотеки	Taskschd.lib
DLL	Taskschd.dll

См. также

IRegisteredTask

планировщик задач

Поделиться через