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

Exclui um gatilho de um item de trabalho.

Sintaxe

HRESULT DeleteTrigger(
  [in] WORD iTrigger
);

Parâmetros

[in] iTrigger

Um valor de índice de gatilho que especifica o gatilho a ser excluído. Para obter mais informações, consulte Comentários.

Retornar valor

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

Um índice de gatilho é criado para cada gatilho quando o gatilho é criado. No entanto, não é um identificador exclusivo para um gatilho específico. 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.

Para concluir a exclusão do gatilho, os programas devem chamar o método IPersistFile::Save depois de chamar DeleteTrigger. Chamar IPersistFile::Save salva as alterações no disco.

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

Createtrigger

IScheduledWorkItem

IScheduledWorkItem::GetTriggerCount