Metode IMultiInterfaceEventControl::GetSubscriptions (eventsys.h)

Artikel
08/23/2023

Mengambil kumpulan objek langganan yang terkait dengan metode peristiwa.

Sintaks

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

Parameter

[in] eventIID

Pengidentifikasi antarmuka antarmuka menembak.

[in] bstrMethodName

Metode peristiwa yang terkait dengan koleksi langganan.

[in] optionalCriteria

String yang menentukan kriteria kueri. Jika parameter ini NULL, kueri default yang ditentukan oleh metode SetDefaultQuery digunakan. Untuk detail tentang membentuk ekspresi yang valid untuk parameter ini, lihat bagian Keterangan di bawah ini.

[in] optionalErrorIndex

Lokasi, dinyatakan sebagai offset, dari kesalahan dalam parameter optionalCriteria . Parameter ini tidak boleh NULL.

[out, retval] ppCollection

Alamat penunjuk ke antarmuka IEventObjectCollection pada objek koleksi yang menghitung langganan yang terkait dengan objek peristiwa.

Menampilkan nilai

Metode ini dapat mengembalikan nilai pengembalian standar E_INVALIDARG, E_OUTOFMEMORY, E_UNEXPECTED, dan E_FAIL, serta nilai berikut.

Menampilkan kode	Deskripsi
S_OK	Metode berhasil diselesaikan.
EVENT_E_QUERYSYNTAX	Terjadi kesalahan sintaks saat mencoba mengevaluasi string kueri.
EVENT_E_QUERYFIELD	Nama bidang yang tidak valid digunakan dalam string kueri.
EVENT_E_INTERNALEXCEPTION	Pengecualian tak terduga dimunculkan.
EVENT_E_INTERNALERROR	Kesalahan internal yang tidak terduga terdeteksi.

Keterangan

Metode ini adalah bentuk yang lebih khusus dari metode IEventSystem::Query . Selain hanya mendapatkan objek langganan, koleksi yang diperoleh dengan memanggil GetSubscriptions diperbarui secara otomatis setiap kali kumpulan langganan berubah.

Kriteria kueri yang ditentukan oleh parameter optionalCriteria dapat berupa "ALL", untuk menentukan permintaan untuk semua objek langganan, atau ekspresi Boolean yang menunjukkan satu atau beberapa kondisi yang harus dipenuhi objek langganan untuk disertakan dalam hasil kueri. Ekspresi yang valid adalah dari formulir berikut:

[TIDAK] nilaipropertynamerelationalOperator. Operator relasional yang valid adalah sebagai berikut:

==, =, !=, <>, ~=. Nilai yang valid adalah "string", 'string', {GUID}, TRUE, FALSE, NULL.

Ekspresi Boolean individual dapat digabungkan dengan AND atau OR. Ekspresi dapat ditumpuk dalam tanda kurung untuk memberlakukan urutan evaluasi tertentu.

Berikut ini adalah beberapa contoh kriteria kueri yang valid:

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

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

Persyaratan


Klien minimum yang didukung	Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	eventsys.h

Lihat juga

IMultiInterfaceEventControl

Bagikan melalui