Método IScheduledWorkItem::SetIdleWait (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 .] ]

Define os minutos em que o sistema deve estar ocioso antes que o item de trabalho possa ser executado.

Sintaxe

HRESULT SetIdleWait(
  [in] WORD wIdleMinutes,
  [in] WORD wDeadlineMinutes
);

Parâmetros

[in] wIdleMinutes

Um valor que especifica por quanto tempo, em minutos, o sistema deve permanecer ocioso antes que o item de trabalho possa ser executado.

[in] wDeadlineMinutes

Um valor 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 SetIdleWait retorna S_OK.

Comentários

O tempo ocioso especificado aqui é usado em conjunto com gatilhos ociosos e condições ociosas. Para obter mais informações, consulte Condições ociosas da tarefa. Gatilhos ociosos são gatilhos baseados em eventos que não estão associados a um horário agendado. As condições ociosas, por outro lado, estão associadas à hora de início agendada para a tarefa.

Especifique gatilhos ociosos definindo o membro TASK_TRIGGER_TYPE do TASK_TRIGGER como TASK_EVENT_TRIGGER_ON_IDLE. O gatilho ocioso é acionado quando o sistema fica ocioso pela quantidade de tempo especificada por wIdleMinutes.

Você define 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 especificado por wIdleMinutes. O serviço Agendador de Tarefas aguardará até o número de minutos especificado em wDeadlineMinutes após a hora de início agendada para ver se o sistema fica ocioso.

Os aplicativos devem chamar o método IPersistFile::Save depois de chamar SetIdleWait para atualizar o intervalo de espera ocioso.

Exemplos

Para obter um exemplo de como definir o tempo de espera ocioso ao criar um gatilho ocioso, consulte Criando um exemplo de gatilho ocioso.

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::GetIdleWait