estrutura TASK_TRIGGER (mstask.h)

Artigo
08/25/2023

Define os horários para executar um item de trabalho agendado.

Sintaxe

typedef struct _TASK_TRIGGER {
  WORD               cbTriggerSize;
  WORD               Reserved1;
  WORD               wBeginYear;
  WORD               wBeginMonth;
  WORD               wBeginDay;
  WORD               wEndYear;
  WORD               wEndMonth;
  WORD               wEndDay;
  WORD               wStartHour;
  WORD               wStartMinute;
  DWORD              MinutesDuration;
  DWORD              MinutesInterval;
  DWORD              rgFlags;
  TASK_TRIGGER_TYPE  TriggerType;
  TRIGGER_TYPE_UNION Type;
  WORD               Reserved2;
  WORD               wRandomMinutesInterval;
} TASK_TRIGGER, *PTASK_TRIGGER;

Membros

cbTriggerSize

Tamanho dessa estrutura, em bytes.

Reserved1

Somente para uso interno; esse valor deve ser zero.

wBeginYear

Ano em que o gatilho de tarefa é ativado. Esse valor deve ser de quatro dígitos (1997, não 97). O ano inicial deve ser especificado ao definir uma tarefa.

wBeginMonth

Mês do ano (especificado no membro wBeginYear ) que o gatilho de tarefa ativa. O mês inicial deve ser especificado ao definir uma tarefa.

wBeginDay

Dia do mês (especificado no membro wBeginMonth ) que o gatilho de tarefa ativa. O dia de início deve ser especificado ao definir uma tarefa.

wEndYear

Ano em que o gatilho de tarefa desativa. Esse valor deve ser de quatro dígitos (1997, não 97).

wEndMonth

Mês do ano (especificado no membro wEndYear ) que o gatilho de tarefa desativa.

wEndDay

Dia do mês (especificado no membro wEndMonth ) que o gatilho de tarefa desativa.

wStartHour

Hora do dia em que a tarefa é executada. Esse valor está em um relógio de 24 horas; as horas vão de 00 a 23.

wStartMinute

Minuto da hora (especificado no membro wStartHour ) que a tarefa executa.

MinutesDuration

Número de minutos após o início da tarefa que o gatilho permanecerá ativo. O número de minutos especificado aqui deve ser maior ou igual à configuração MinutesInterval .

Por exemplo, se você iniciar uma tarefa às 8h e quiser iniciar a tarefa repetidamente até as 17h, haverá 540 minutos na duração.

MinutesInterval

Número de minutos entre execuções de tarefas consecutivas. Esse número é contado desde o início da tarefa agendada anterior. O número de minutos especificado aqui deve ser menor que a configuração MinutesDuration .

Por exemplo, para executar uma tarefa a cada hora das 8h às 17h, defina esse campo como 60.

rgFlags

Valor que descreve o comportamento do gatilho. Esse valor é uma combinação dos sinalizadores a seguir.

TASK_TRIGGER_FLAG_HAS_END_DATE

A data de término da estrutura do gatilho é válida. Se esse sinalizador não estiver definido, os dados de data de término serão ignorados e o gatilho será válido indefinidamente.

TASK_TRIGGER_FLAG_KILL_AT_DURATION_END

A tarefa será encerrada no final do tempo de vida do gatilho ativo. No final da duração, o Agendador de Tarefas envia uma mensagem WM_CLOSE para o aplicativo associado. Se WM_CLOSE não puder ser enviado (por exemplo, o aplicativo não tiver janelas) ou o aplicativo não tiver sido encerrado dentro de três minutos após o recebimento WM_CLOSE, o Agendador de Tarefas encerrará o aplicativo usando TerminateProcess.

TASK_TRIGGER_FLAG_DISABLED

O gatilho da tarefa está inativo.

TriggerType

Um TASK_TRIGGER_TYPE valor enumerado que especifica o tipo de gatilho. Esse membro é usado com Type. O tipo de gatilho especificado aqui determina quais campos do TRIGGER_TYPE_UNION especificado no membro Type serão usados. O tipo de gatilho é baseado em quando o gatilho executará a tarefa.

Type

Uma estrutura TRIGGER_TYPE_UNION que especifica detalhes sobre o gatilho. Observe que o membro TriggerType determina quais campos da união TRIGGER_TYPE_UNION serão usados.

Reserved2

Somente para uso interno; esse valor deve ser zero.

wRandomMinutesInterval

Não usado no momento.

Comentários

Esses horários podem incluir os sinalizadores de hora de início, hora de término, duração e modificação do item de trabalho. Observe que, ao definir um gatilho, o mês e o ano do dia de início devem ser definidos.

Nota Um item de trabalho agendado pode ter um ou mais gatilhos definidos. As horas em que o item de trabalho será executado é a união de todos os gatilhos definidos para esse item.

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]
Cabeçalho	mstask.h