Compartir a través de

Método IMultiInterfaceEventControl::GetSubscriptions (eventsys.h)

  • Artículo

Recupera la colección de objetos de suscripción asociados a un método de evento.

Sintaxis

HRESULT GetSubscriptions(
  [in]          REFIID                 eventIID,
  [in]          BSTR                   bstrMethodName,
  [in]          BSTR                   optionalCriteria,
  [in]          int                    *optionalErrorIndex,
  [out, retval] IEventObjectCollection **ppCollection
);

Parámetros

[in] eventIID

Identificador de interfaz de la interfaz de activación.

[in] bstrMethodName

Método de evento asociado a la colección de suscripciones.

[in] optionalCriteria

Cadena que especifica los criterios de consulta. Si este parámetro es NULL, se usa la consulta predeterminada especificada por el método SetDefaultQuery . 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.

[in] optionalErrorIndex

Ubicación, expresada como desplazamiento, de un error en el parámetro optionalCriteria . Este parámetro no puede ser NULL.

[out, retval] ppCollection

Dirección de un puntero a una interfaz IEventObjectCollection en un objeto de colección que enumera las suscripciones asociadas al objeto de evento.

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_INTERNALEXCEPTION
 Se generó una excepción inesperada.
EVENT_E_INTERNALERROR
 Se detectó un error interno inesperado.

Comentarios

Este método es una forma más especializada del método IEventSystem::Query . Además de obtener solo objetos de suscripción, una colección obtenida llamando a GetSubscriptions se actualiza automáticamente cada vez que cambia la colección de suscripciones.

Los criterios de consulta especificados por el parámetro optionalCriteria 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

IMultiInterfaceEventControl