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

[[Essa API pode estar alterada ou indisponível em versões subsequentes do sistema operacional ou do produto. Em vez disso, use as Interfaces do Agendador de Tarefas 2.0 .] ]

O método GetTriggerString recupera o gatilho de tarefa atual na forma de uma cadeia de caracteres. Essa cadeia de caracteres aparece na interface do usuário do Agendador de Tarefas em um formato semelhante a "Às 14h todos os dias, a partir de 11/05/97".

Sintaxe

HRESULT GetTriggerString(
  [out] LPWSTR *ppwszTrigger
);

Parâmetros

[out] ppwszTrigger

Um ponteiro para um ponteiro para uma cadeia de caracteres terminada em nulo que descreve o gatilho de tarefa atual. O método que invoca GetTriggerString é responsável por liberar essa cadeia de caracteres usando a função CoTaskMemFree .

Retornar valor

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

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

ITaskTrigger

ITaskTrigger::GetTrigger

ITaskTrigger::SetTrigger