Compartilhar via

Método IScheduledWorkItem::GetExitCode (mstask.h)

  • Artigo

[[Essa API pode estar alterada ou indisponível em versões subsequentes do sistema operacional ou produto. Em vez disso, use as Interfaces do Agendador de Tarefas 2.0 .] ]

Recupera o último código de saída retornado pelo executável associado ao item de trabalho em sua última execução. O método também retorna o código de saída retornado ao Agendador de Tarefas quando tentou executar o item de trabalho pela última vez.

Sintaxe

HRESULT GetExitCode(
  [out] DWORD *pdwExitCode
);

Parâmetros

[out] pdwExitCode

Um ponteiro para um valor DWORD definido como o último código de saída para o item de trabalho. Esse é o código de saída que o item de trabalho retornou quando parou de ser executado pela última vez. Se o item de trabalho nunca tiver sido iniciado, 0 será retornado.

Retornar valor

O método GetExitCode retorna o erro da última tentativa de iniciar o item de trabalho. Os possíveis valores incluem os seguintes.

Código de retorno Descrição
S_OK
 A tentativa de iniciar o item de trabalho foi bem-sucedida.
SCHED_S_TASK_HAS_NOT_RUN
 Nenhuma tentativa foi feita para iniciar este item de trabalho.
E_INVALIDARG
 Os argumentos não são válidos.
E_OUTOFMEMORY
 Não existe memória suficiente.

Comentários

Esse método pode retornar as duas informações a seguir:

  • O código de erro ou de saída retornado pelo executável que está sendo agendado é retornado no parâmetro pdwExitCode .
  • O código de erro que o Agendador de Tarefas recebeu quando tentou iniciar o trabalho é retornado na própria chamada do método GetExitCode .
Para obter um código de erro atualizado, sempre chame ITaskScheduler::Activate primeiro para obter uma nova interface IScheduledWorkItem , que pode ser usada para obter os códigos de erro atualizados.

Exemplos

Para obter um exemplo de como recuperar o criador de uma tarefa, consulte Exemplo de código C/C++: recuperando o código de saída da tarefa.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho mstask.h
Biblioteca Mstask.lib
DLL Mstask.dll
Redistribuível Internet Explorer 4.0 ou posterior no Windows NT 4.0 e Windows 95

Confira também

IScheduledWorkItem