Método IEventSystem::Remove (eventsys.h)

  • Artigo

Remove um ou mais objetos de assinatura ou evento do armazenamento de dados de eventos.

Sintaxe

HRESULT Remove(
  [in]  BSTR progID,
  [in]  BSTR queryCriteria,
  [out] int  *errorIndex
);

Parâmetros

[in] progID

O ProgID da classe de objeto a ser removida. Deve ser um identificador de classe de objeto de evento válido. Esse parâmetro pode usar um dos valores a seguir:

  • PROGID_EventClass
  • PROGID_EventClassCollection
  • PROGID_EventSubscription
  • PROGID_EventSubscriptionCollection

[in] queryCriteria

Os critérios de consulta. Para obter detalhes sobre como formar uma expressão válida para esse parâmetro, consulte a seção Comentários abaixo.

[out] errorIndex

O local, expresso como um deslocamento, de um erro no parâmetro queryCriteria .

Valor retornado

Esse método pode retornar os valores retornados padrão E_INVALIDARG, E_OUTOFMEMORY, E_UNEXPECTED e E_FAIL, bem como os valores a seguir.

Código de retorno Descrição
S_OK
 O método foi concluído com sucesso.
EVENT_E_QUERYSYNTAX
 Ocorreu um erro de sintaxe ao tentar avaliar uma cadeia de caracteres de consulta.
EVENT_E_QUERYFIELD
 Um nome de campo inválido foi usado em uma cadeia de caracteres de consulta.
EVENT_E_NOT_ALL_REMOVED
 Nem todos os objetos solicitados puderam ser removidos.

Comentários

Os critérios de consulta especificados pelo parâmetro queryCriteria podem ser "ALL", para especificar uma solicitação para todos os objetos de assinatura ou uma expressão booliana que indica uma ou mais condições que um objeto de assinatura deve atender para ser incluída no resultado da consulta. As expressões válidas são da seguinte forma:

[NOT] propertynamerelationalOperatorvalue. Os operadores relacionais válidos são os seguintes:

==, =, !=, <>, ~=. Os valores válidos são "string", 'string', {GUID}, TRUE, FALSE, NULL.

Expressões boolianas individuais podem ser unidas com AND ou OR. As expressões podem ser aninhadas entre parênteses para impor uma ordem específica de avaliação.

A seguir estão alguns exemplos de critérios de consulta válidos:

"EventClassID == {F89859D1-6565-11D1-88C8-0080C7D771BF}"

"EventClassID == {F89859D1-6565-11D1-88C8-0080C7D771BF} AND MethodName = 'StockPriceChange'"

Requisitos

   
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 eventsys.h

Confira também

IEventSystem