IEventControl::GetSubscriptions-Methode (eventsys.h)

Ruft die Auflistung von Abonnements ab, die einer Ereignismethode zugeordnet sind.

Syntax

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

Parameter

[in] methodName

Die der Abonnementauflistung zugeordnete Ereignismethode.

[in] optionalCriteria

Die Abfragekriterien. Wenn dieser Parameter NULL ist, wird die von der SetDefaultQuery-Methode angegebene Standardabfrage verwendet. Ausführliche Informationen zum Erstellen eines gültigen Ausdrucks für diesen Parameter finden Sie weiter unten im Abschnitt Hinweise.

[in] optionalErrorIndex

Die Position eines Fehlers im OptionalCriteria-Parameter , ausgedrückt als Offset. Dieser Parameter darf nicht NULL sein.

[out, retval] ppCollection

Adresse eines Zeigers auf die IEventObjectCollection-Schnittstelle für ein Auflistungsobjekt, das die dem Ereignisobjekt zugeordneten Abonnements aufzählt.

Rückgabewert

Wenn diese Methode erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

Diese Methode ist eine spezialisiertere Form der IEventSystem::Query-Methode . Zusätzlich zum Abrufen von nur Abonnementobjekten wird eine Sammlung, die durch Aufrufen von GetSubscriptions abgerufen wird, automatisch aktualisiert, wenn sich die Abonnementauflistung ändert.

Die durch den optionalCriteria-Parameter angegebenen Abfragekriterien können "ALL" sein, um eine Anforderung für alle Abonnementobjekte anzugeben, oder einen booleschen Ausdruck, der eine oder mehrere Bedingungen angibt, die ein Abonnementobjekt erfüllen muss, um in das Abfrageergebnis eingeschlossen zu werden. Gültige Ausdrücke haben die folgende Form:

[NICHT] propertynamerelationalOperator-Wert. Gültige relationale Operatoren sind wie folgt:

==, =, !=, <>, ~=. Gültige Werte sind "string", "string", {GUID}, TRUE, FALSE, NULL.

Einzelne boolesche Ausdrücke können mit AND oder OR verknüpft werden. Ausdrücke können in Klammern geschachtelt werden, um eine bestimmte Reihenfolge der Auswertung zu erzwingen.

Im Folgenden sind einige Beispiele für gültige Abfragekriterien aufgeführt:

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

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

Anforderungen

Weitere Informationen

IEventControl