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

Artigo
03/15/2023

[[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 .] ]

Cria um gatilho para o item de trabalho.

Sintaxe

HRESULT CreateTrigger(
  [out] WORD         *piNewTrigger,
  [out] ITaskTrigger **ppTrigger
);

Parâmetros

[out] piNewTrigger

Um ponteiro para o valor de índice de gatilho retornado do novo gatilho. O índice de gatilho para o primeiro gatilho associado a um item de trabalho é "0". Consulte Comentários para outros usos do índice de gatilho.

[out] ppTrigger

Um ponteiro para um ponteiro para uma interface ITaskTrigger . Atualmente, os únicos itens de trabalho com suporte são tarefas.

Retornar valor

O método CreateTrigger 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

Use o índice de gatilho retornado por piNewTrigger quando estiver recuperando ou excluindo gatilhos. No entanto, o índice de gatilho não é um identificador. Indica apenas a posição do novo gatilho em relação aos outros gatilhos atuais associados ao item de trabalho.

Para definir os critérios para o novo gatilho, chame ITaskTrigger::SetTrigger.

Depois de criar um novo gatilho para um item de trabalho, os aplicativos devem chamar o método IPersistFile::Save para salvar o novo gatilho em disco.

Exemplos

Para obter um exemplo de como definir os critérios de gatilho ao criar um novo gatilho, consulte Criando um novo gatilho.

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