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

Article
02/26/2024

Récupère la collection d’abonnements associés à une méthode d’événement.

Syntaxe

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

Paramètres

[in] methodName

Méthode d’événement associée à la collection d’abonnements.

[in] optionalCriteria

Critères de requête. Si ce paramètre a la valeur NULL, la requête par défaut spécifiée par la méthode SetDefaultQuery est utilisée. Pour plus d’informations sur la formation d’une expression valide pour ce paramètre, consultez la section Remarques ci-dessous.

[in] optionalErrorIndex

Emplacement, exprimé sous forme de décalage, d’une erreur dans le paramètre OptionalCriteria . Ce paramètre ne peut pas avoir la valeur NULL.

[out, retval] ppCollection

Adresse d’un pointeur vers l’interface IEventObjectCollection sur un objet de collection qui énumère les abonnements associés à l’objet d’événement.

Valeur retournée

Si cette méthode réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.

Remarques

Cette méthode est une forme plus spécialisée de la méthode IEventSystem ::Query . En plus d’obtenir uniquement des objets d’abonnement, une collection obtenue en appelant GetSubscriptions est automatiquement mise à jour chaque fois que la collection d’abonnements change.

Les critères de requête spécifiés par le paramètre optionalCriteria peuvent être « ALL », pour spécifier une requête pour tous les objets d’abonnement, ou une expression booléenne indiquant une ou plusieurs conditions qu’un objet d’abonnement doit remplir pour être inclus dans le résultat de la requête. Les expressions valides sont de la forme suivante :

[NOT] valeur de propertynamerelationalOperator. Les opérateurs relationnels valides sont les suivants :

==, =, !=, <>, ~=. Les valeurs valides sont « string », « string », {GUID}, TRUE, FALSE, NULL.

Les expressions booléennes individuelles peuvent être jointes à AND ou OR. Les expressions peuvent être imbriquées entre parenthèses pour appliquer un ordre d’évaluation spécifique.

Voici quelques exemples de critères de requête valides :

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

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

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	eventsys.h

Voir aussi

IEventControl

Partager via