Método IScheduledWorkItem::SetFlags (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 sinalizadores que modificam o comportamento de qualquer tipo de item de trabalho.

Sintaxe

HRESULT SetFlags(
  DWORD dwFlags
);

Parâmetros

dwFlags

Um valor que especifica uma combinação de um ou mais dos seguintes sinalizadores:

TASK_FLAG_INTERACTIVE

Esse sinalizador é usado ao converter trabalhos de serviço Windows NT AT em itens de trabalho. O trabalho de serviço Windows NT AT refere-se a At.exe, o utilitário de linha de comando Windows NT usado para criar trabalhos para o serviço agendamento de Windows NT. O serviço Agendador de Tarefas substitui o serviço Agendamento e é compatível com versões anteriores com ele. A conversão ocorre quando o Agendador de Tarefas é instalado no Windows NT/Windows 2000, por exemplo, se você instalar o Internet Explorer 4.0 ou atualizar para o Windows 2000. Durante o processo de instalação, o código de instalação do Agendador de Tarefas pesquisa no Registro trabalhos criados para o serviço AT e cria itens de trabalho que realizarão a mesma operação.

Para esses trabalhos convertidos, o sinalizador interativo será definido se o item de trabalho for exibido para o usuário. Quando esse sinalizador não está definido, nenhum item de trabalho é exibido na pasta Tarefas e nenhuma interface do usuário associada ao item de trabalho é apresentada ao usuário quando o item de trabalho é executado.

TASK_FLAG_DELETE_WHEN_DONE

O item de trabalho será excluído quando não houver mais tempos de execução agendados.

TASK_FLAG_DISABLED

O item de trabalho está desabilitado. Isso é útil para impedir temporariamente que um item de trabalho seja executado nos horários agendados.

TASK_FLAG_HIDDEN

O item de trabalho criado ficará oculto.

TASK_FLAG_RUN_ONLY_IF_LOGGED_ON

O item de trabalho será executado somente se o usuário especificado em IScheduledWorkItem::SetAccountInformation estiver conectado interativamente. Esse sinalizador não tem efeito sobre os itens de trabalho definidos para serem executados na conta local.

TASK_FLAG_START_ONLY_IF_IDLE

O item de trabalho começa somente se o computador não estiver em uso na hora de início agendada.

TASK_FLAG_SYSTEM_REQUIRED

O item de trabalho fará com que o sistema seja retomado ou despertado se o sistema estiver em execução na energia da bateria. Esse sinalizador tem suporte apenas em sistemas que dão suporte a temporizadores de retomada.

TASK_FLAG_KILL_ON_IDLE_END

O item de trabalho será encerrado se o computador fizer uma transição ociosa para não ociosa enquanto o item de trabalho estiver em execução. O computador não é considerado ocioso até que o tempo dos gatilhos IdleWait desça sem entrada do usuário. Para obter informações sobre gatilhos ociosos, consulte Gatilho ocioso.

TASK_FLAG_RESTART_ON_IDLE_RESUME

O item de trabalho será iniciado novamente se o computador fizer uma transição não ociosa para ociosa antes que todos os task_triggers do item de trabalho se desfaciem. (Use esse sinalizador em conjunto com TASK_FLAG_KILL_ON_IDLE_END.)

TASK_FLAG_DONT_START_IF_ON_BATTERIES

O item de trabalho não será iniciado se o computador de destino estiver em execução com a energia da bateria.

TASK_FLAG_KILL_IF_GOING_ON_BATTERIES

O item de trabalho termina e o aplicativo associado é encerrado se o computador de destino do item de trabalho alterna para a energia da bateria.

TASK_FLAG_RUN_IF_CONNECTED_TO_INTERNET

O item de trabalho será executado somente se houver uma conexão de Internet válida no momento.

Nota No momento, esse recurso não está implementado.

 

Retornar valor

O método SetFlags 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.
E_OUTOFMEMORY	Não existe memória suficiente.

Comentários

Os programas devem chamar o método IPersistFile::Save depois de chamar SetFlags para atualizar os sinalizadores.

Esse método é usado para definir os sinalizadores usados por qualquer tipo de item de trabalho agendado. Por outro lado, ITask::SetTaskFlags é usado apenas para definir sinalizadores usados por tarefas agendadas.

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

IScheduledWorkItem::SetAccountInformation