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

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

  • Статья

Немедленно запускает зарегистрированную задачу.

Синтаксис

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

Параметры

[in] params

Параметры, используемые в качестве значений в действиях задачи. Чтобы не указывать значения параметров для действий задачи, задайте для этого параметра значение VT_NULL или VT_EMPTY. В противном случае можно указать одно значение 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 , определяющий новый экземпляр задачи.

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

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

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

Комментарии

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

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

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

Требования

   
Минимальная версия клиента Windows Vista [только классические приложения]
Минимальная версия сервера Windows Server 2008 [только классические приложения]
Целевая платформа Windows
Header taskschd.h
Библиотека Taskschd.lib
DLL Taskschd.dll

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

IRegisteredTask

Планировщик заданий