Método IRegisteredTask::Run (taskschd.h)

  • Artigo

Executa a tarefa registrada imediatamente.

Sintaxe

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

Parâmetros

[in] params

Os parâmetros usados como valores nas ações da tarefa. Para não especificar nenhum valor de parâmetro para as ações de tarefa, defina esse parâmetro como VT_NULL ou VT_EMPTY. Caso contrário, um único valor BSTR ou uma matriz de valores BSTR pode ser especificado.

Os valores BSTR especificados são emparelhados com nomes e armazenados como pares nome-valor. Se você especificar um único valor BSTR , Arg0 será o nome atribuído ao valor. O valor pode ser usado na ação de tarefa em que a variável $(Arg0) é usada nas propriedades da ação.

Se você passar valores como "0", "100" e "250" como uma matriz de valores BSTR , "0" substituirá as variáveis $(Arg0), "100" substituirá as variáveis $(Arg1) e "250" substituirá as variáveis $(Arg2) usadas nas propriedades da ação.

Um máximo de 32 valores BSTR pode ser especificado.

Para obter mais informações e uma lista de propriedades de ação que podem usar variáveis $(Arg0), $(Arg1), ..., $(Arg32) em seus valores, consulte Ações da Tarefa.

[out, optional] ppRunningTask

Uma interface IRunningTask que define a nova instância da tarefa.

Passe uma referência a um ponteiro de interface IRunningTaskNULL. Fazer referência a um ponteiro não NULL pode causar um vazamento de memória porque o ponteiro será substituído.

Retornar valor

Se o método for bem-sucedido, ele retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.

Comentários

Esse método retornará sem erros, mas a tarefa não será executada se a propriedade AllowDemandStart de ITaskSettings estiver definida como false para a tarefa.

A função IRegisteredTask::Run é equivalente à função IRegisteredTask::RunEx com o parâmetro flags igual a 0 e o parâmetro user igual a NULL.

Se IRegisteredTask::Run for invocado de uma tarefa desabilitada, ela retornará SCHED_E_TASK_DISABLED.

Requisitos

   
Cliente mínimo com suporte Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho taskschd.h
Biblioteca Taskschd.lib
DLL Taskschd.dll

Confira também

IRegisteredTask

Agendador de Tarefas