Share via

IMultiInterfaceEventControl::GetSubscriptions-Methode (eventsys.h)

  • Artikel

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

Syntax

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

Parameter

[in] eventIID

Der Schnittstellenbezeichner der auslösungsschnittstelle.

[in] bstrMethodName

Die der Abonnementauflistung zugeordnete Ereignismethode.

[in] optionalCriteria

Eine Zeichenfolge, die die Abfragekriterien angibt. 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

Die Adresse eines Zeigers auf eine IEventObjectCollection-Schnittstelle in einem Auflistungsobjekt, das die dem Ereignisobjekt zugeordneten Abonnements aufzählt.

Rückgabewert

Diese Methode kann die Standardrückgabewerte E_INVALIDARG, E_OUTOFMEMORY, E_UNEXPECTED und E_FAIL sowie die folgenden Werte zurückgeben.

Rückgabecode BESCHREIBUNG
S_OK
 Die Methode wurde erfolgreich abgeschlossen.
EVENT_E_QUERYSYNTAX
 Beim Auswerten einer Abfragezeichenfolge ist ein Syntaxfehler aufgetreten.
EVENT_E_QUERYFIELD
 In einer Abfragezeichenfolge wurde ein ungültiger Feldname verwendet.
EVENT_E_INTERNALEXCEPTION
 Es wurde eine unerwartete Ausnahme ausgelöst.
EVENT_E_INTERNALERROR
 Ein unerwarteter interner Fehler wurde erkannt.

Hinweise

Diese Methode ist eine speziellere 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 Abonnementsammlung ändert.

Die durch den optionalCriteria-Parameter angegebenen Abfragekriterien können "ALL" sein, um eine Anforderung für alle Abonnementobjekte anzugeben, oder ein boolescher Ausdruck, der eine oder mehrere Bedingungen angibt, die ein Abonnementobjekt erfüllen muss, um in das Abfrageergebnis aufgenommen 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 Auswertungsreihenfolge 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

   
Unterstützte Mindestversion (Client) Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows 2000 Server [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile eventsys.h

Weitere Informationen

IMultiInterfaceEventControl