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

Recupera uma cadeia de caracteres que descreve o gatilho de item de trabalho .

Sintaxe

HRESULT GetTriggerString(
  [in]  WORD   iTrigger,
  [out] LPWSTR *ppwszTrigger
);

Parâmetros

[in] iTrigger

O índice do gatilho a ser recuperado. O primeiro gatilho é sempre referenciado por 0. Para obter mais informações, consulte Comentários.

[out] ppwszTrigger

Um ponteiro para uma cadeia de caracteres terminada em nulo que contém a descrição do gatilho recuperada. Observe que essa cadeia de caracteres deve ser lançada por uma chamada para CoTaskMemFree depois que a cadeia de caracteres não for mais necessária.

Retornar valor

O método GetTriggerString retorna um dos valores a seguir.

Comentários

Um índice de gatilho não é um identificador. Ele indica apenas a posição do gatilho em relação aos gatilhos atuais associados ao item de trabalho. Por exemplo, se você criar quatro gatilhos, eles serão numerados de 0 a 3. Mas se o segundo gatilho for excluído, os gatilhos restantes serão numerados de 0 a 2. Observe que o índice do primeiro gatilho é sempre 0 e o índice do último gatilho é um menor que o número total de gatilhos para o item de trabalho (TriggerCount -1).

Você pode recuperar a contagem de gatilhos usando IScheduledWorkItem::GetTriggerCount.

Exemplos

Para obter um exemplo de como recuperar a cadeia de caracteres de gatilho de todos os gatilhos associados a uma tarefa, consulte Recuperando exemplo de cadeias de caracteres de gatilho.

Requisitos

Confira também

IScheduledWorkItem

Itask