Método ITaskTrigger::SetTrigger (mstask.h)

Artigo
08/25/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 .] ]

O método SetTrigger define os critérios de gatilho para um gatilho de tarefa.

Sintaxe

HRESULT SetTrigger(
  [in] const PTASK_TRIGGER pTrigger
);

Parâmetros

[in] pTrigger

Um ponteiro para uma estrutura TASK_TRIGGER que contém os valores que definem o novo gatilho de tarefa.

Retornar valor

O método SetTrigger 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 membros wBeginDay, wBeginMonth e wBeginYear da estrutura TASK_TRIGGER devem ser definidos como um dia, mês e ano válidos, respectivamente.

Uma tarefa pode ter qualquer número de gatilhos associados a ela. Os horários em que a tarefa será executada são a união de todos os gatilhos definidos para essa tarefa.

Para atualizar a tarefa com essas novas configurações de gatilho, os aplicativos devem chamar o método IPersistFile::Save depois de chamar SetTrigger.

Exemplos

O código a seguir mostra a declaração de variável e a sintaxe de chamada para esse método, incluindo os membros necessários do TASK_TRIGGER. Definindo os critérios de gatilho ao criar um novo gatilho, consulte Criando um novo gatilho.

HRESULT hr = S_OK;

TASK_TRIGGER Trigger;

ZeroMemory(&Trigger, sizeof(TASK_TRIGGER));

Trigger.cbTriggerSize = sizeof(TASK_TRIGGER);
Trigger.wBeginDay = 1;
Trigger.wBeginMonth = 1;
Trigger.wBeginYear = 1999;

// pITaskTrigger is a previously assigned ITaskTrigger pointer.
hr = pITaskTrigger->SetTrigger(&Trigger);
if (FAILED(hr))
{
   printf("Failed SetTrigger\n");
   exit(1);
}

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