Método IScheduledWorkItem::GetStatus (mstask.h)
[[Essa API pode estar alterada ou indisponível em versões subsequentes do sistema operacional ou do produto. Em vez disso, use as Interfaces do Agendador de Tarefas 2.0 .] ]
Recupera o status do item de trabalho.
Sintaxe
HRESULT GetStatus(
[out] HRESULT *phrStatus
);
Parâmetros
[out] phrStatus
Um ponteiro para um valor HRESULT que contém um dos seguintes valores no retorno.
SCHED_S_TASK_READY
O item de trabalho está pronto para ser executado no próximo horário agendado.
SCHED_S_TASK_RUNNING
O item de trabalho está em execução no momento.
SCHED_S_TASK_NOT_SCHEDULED
Uma ou mais das propriedades necessárias para executar essa tarefa em um agendamento não foram definidas.
SCHED_S_TASK_HAS_NOT_RUN
A tarefa não foi executada. Esse valor é retornado sempre que a tarefa não tiver sido executada, mesmo se a tarefa estiver pronta para ser executada no próximo horário agendado ou a tarefa for uma tarefa recorrente.
SCHED_S_TASK_DISABLED
A tarefa não será executada nos horários agendados porque foi desabilitada.
SCHED_S_TASK_NO_MORE_RUNS
Não há mais execuções agendadas para esta tarefa.
SCHED_S_TASK_NO_VALID_TRIGGERS
A tarefa não tem gatilhos ou os gatilhos existentes estão desabilitados ou não estão definidos.
Retornar valor
O método GetStatus retorna um dos seguintes valores.
| Código de retorno | Descrição |
|---|---|
|
A operação foi bem-sucedida. A solicitação foi enviada. Para obter mais informações, consulte Comentários. |
|
Os argumentos não são válidos. |
Comentários
Os métodos da interface IScheduledWorkItem são herdados pela interface ITask . Consequentemente, IScheduledWorkItem::GetStatus normalmente é chamado por meio da interface ITask .
IScheduledWorkItem::GetStatus não obtém o status da tarefa dinamicamente. ITaskScheduler::Activate deve ser chamado para obter uma nova interface IScheduledWorkItem, que é usada para obter uma status atualizada. Para obter mais informações, consulte o exemplo de ITaskScheduler::Activate.
Exemplos
Para obter um exemplo de como recuperar o status de uma tarefa, consulte Exemplo de código C/C++: recuperando o status da tarefa.
Para obter um exemplo de como recuperar a tarefa status como parte da terminação da tarefa, consulte Encerrando um exemplo de 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 |