Metodo IEventControl::GetSubscriptions (eventsys.h)

Articolo
02/26/2024

Recupera la raccolta di sottoscrizioni associate a un metodo di evento.

Sintassi

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

Parametri

[in] methodName

Metodo di evento associato alla raccolta di sottoscrizioni.

[in] optionalCriteria

Criteri di query. Se questo parametro è NULL, viene utilizzata la query predefinita specificata dal metodo SetDefaultQuery . Per informazioni dettagliate sulla creazione di un'espressione valida per questo parametro, vedere la sezione Osservazioni di seguito.

[in] optionalErrorIndex

Posizione, espressa come offset, di un errore nel parametro OptionalCriteria . Questo parametro non può essere NULL.

[out, retval] ppCollection

Indirizzo di un puntatore all'interfaccia IEventObjectCollection su un oggetto raccolta che enumera le sottoscrizioni associate all'oggetto evento.

Valore restituito

Se questo metodo ha esito positivo, restituisce S_OK. In caso contrario, restituisce un codice di errore HRESULT .

Commenti

Questo metodo è una forma più specializzata del metodo IEventSystem::Query . Oltre a ottenere solo gli oggetti sottoscrizione, una raccolta ottenuta chiamando GetSubscriptions viene aggiornata automaticamente ogni volta che la raccolta di sottoscrizioni cambia.

I criteri di query specificati dal parametro optionalCriteria possono essere "ALL", per specificare una richiesta per tutti gli oggetti sottoscrizione o un'espressione booleana che indica una o più condizioni che un oggetto sottoscrizione deve soddisfare per essere incluso nel risultato della query. Le espressioni valide sono del formato seguente:

[NOT] propertynamerelationalOperatorvalue. Gli operatori relazionali validi sono i seguenti:

==, =, !=, <>, ~=. I valori validi sono "string", 'string', {GUID}, TRUE, FALSE, NULL.

È possibile unire singole espressioni booleane con AND o OR. Le espressioni possono essere annidate tra parentesi per applicare un ordine specifico di valutazione.

Di seguito sono riportati alcuni esempi di criteri di query validi:

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

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

Requisiti

Requisito	Valore
Client minimo supportato	Windows 2000 Professional [solo app desktop]
Server minimo supportato	Windows 2000 Server [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	eventsys.h

Vedi anche

IEventControl

Condividi tramite