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

[[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 tempo de espera ocioso para o item de trabalho.

Para obter informações sobre condições ociosas, consulte Condições ociosas da tarefa.

Sintaxe

HRESULT GetIdleWait(
  [out] WORD *pwIdleMinutes,
  [out] WORD *pwDeadlineMinutes
);

Parâmetros

[out] pwIdleMinutes

Um ponteiro para um WORD que contém o tempo de espera ocioso para o item de trabalho atual, em minutos.

[out] pwDeadlineMinutes

Um ponteiro para um WORD que especifica o número máximo de minutos que o Agendador de Tarefas aguardará pelo período de tempo ocioso retornado em pwIdleMinutes.

Retornar valor

O método GetIdleWait retorna um dos valores a seguir.

Código de retorno	Descrição
S_OK	A operação foi bem-sucedida.
E_INVALIDARG	Os argumentos não são válidos.

Comentários

O tempo ocioso retornado aqui é usado em conjunto com gatilhos ociosos e condições ociosas. Gatilhos ociosos são gatilhos baseados em eventos que não estão associados a um horário agendado. As condições ociosas estão associadas à hora de início agendada para a tarefa.

Gatilhos ociosos são especificados definindo o membro TASK_TRIGGER_TYPE da estrutura TASK_TRIGGER para o valor TASK_EVENT_TRIGGER_ON_IDLE. O gatilho ocioso é acionado quando o sistema fica ocioso pela quantidade de tempo retornada em pwIdleMinutes.

Você pode definir condições ociosas chamando IScheduledWorkItem::SetFlags. Se o sinalizador TASK_FLAG_START_ONLY_IF_IDLE estiver definido, o item de trabalho será executado em seu horário agendado somente se o sistema ficar ocioso pelo período de tempo retornado em pwIdleMinutes. O serviço Agendador de Tarefas aguardará até pwDeadlineMinutes após a hora de início agendada para ver se o sistema fica ocioso.

Exemplos

Para obter um exemplo de como recuperar o tempo de espera ocioso de uma tarefa, consulte Exemplo de código C/C++: recuperando o tempo de espera ocioso 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

IScheduledWorkItem::SetIdleWait