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

Recupera la colección de suscripciones asociadas a un método de evento.

Sintaxis

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

Parámetros

[in] methodName

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

[in] optionalCriteria

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, consulte la sección Comentarios a continuación.

[in] optionalErrorIndex

Ubicación, expresada como un 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 la interfaz IEventObjectCollection en un objeto de colección que enumera las suscripciones asociadas al objeto de evento.

Valor devuelto

Si este método se realiza correctamente, devuelve S_OK. De lo contrario, devuelve un código de error de HRESULT.

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 mediante una llamada 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 indica 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 u 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

Requisito	Value
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

IEventControl