Compartir a través de

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

  • Artículo

Quita uno o varios objetos de evento o suscripción del almacén de datos de eventos.

Sintaxis

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

Parámetros

[in] progID

ProgID de la clase de objeto que se va a quitar. Debe ser un identificador de clase de objeto de evento válido. Este parámetro puede establecerse con uno de los siguientes valores:

  • PROGID_EventClass
  • PROGID_EventClassCollection
  • PROGID_EventSubscription
  • PROGID_EventSubscriptionCollection

[in] queryCriteria

Criterios de consulta. Para obtener más información sobre cómo formar una expresión válida para este parámetro, vea la sección Comentarios a continuación.

[out] errorIndex

Ubicación, expresada como desplazamiento, de un error en el parámetro queryCriteria .

Valor devuelto

Este método puede devolver los valores devueltos estándar E_INVALIDARG, E_OUTOFMEMORY, E_UNEXPECTED y E_FAIL, así como los siguientes valores.

Código devuelto Descripción
S_OK
 El método se completó correctamente.
EVENT_E_QUERYSYNTAX
 Error de sintaxis al intentar evaluar una cadena de consulta.
EVENT_E_QUERYFIELD
 Se usó un nombre de campo no válido en una cadena de consulta.
EVENT_E_NOT_ALL_REMOVED
 No se podrían quitar todos los objetos solicitados.

Comentarios

Los criterios de consulta especificados por el parámetro queryCriteria pueden ser "ALL", para especificar una solicitud para todos los objetos de suscripción o una expresión booleana que indique una o varias condiciones que debe cumplir un objeto de suscripción para incluirse en el resultado de la consulta. Las expresiones válidas tienen el formato siguiente:

[NOT] propertynamerelationalOperatorvalue. Los operadores relacionales válidos son los siguientes:

==, =, !=, <>, ~=. Los valores válidos son "string", 'string', {GUID}, TRUE, FALSE, NULL.

Las expresiones booleanas individuales se pueden combinar con AND o OR. Las expresiones se pueden anidar entre paréntesis para aplicar un orden específico de evaluación.

A continuación se muestran algunos ejemplos de criterios de consulta válidos:

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

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

Requisitos

   
Cliente mínimo compatible Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado eventsys.h

Consulte también

IEventSystem