Win32 API 日本語リファレンス
ホーム › System.Com.Events › IEventSubscription

IEventSubscription

COMIDispatch (デュアル)
📘 Microsoft Learn (日本語) · English
✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IID4a6b0e15-2e38-11d1-9965-00c04fbbb345継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

イベントのサブスクライバーと、サブスクライブ対象のイベントとの関係に関する情報を指定します。パブリッシャーフィルターによって使用されます。

メソッド 34

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 7 HRESULT get_SubscriptionID(LPWSTR* pbstrSubscriptionID)

サブスクリプションオブジェクトの一意な ID です。(Get)

pbstrSubscriptionIDLPWSTR*outサブスクリプションの識別子を文字列として受け取る。
vtbl 8 HRESULT put_SubscriptionID(LPWSTR bstrSubscriptionID)

サブスクリプションオブジェクトの一意な ID です。(Put)

bstrSubscriptionIDLPWSTRinサブスクリプションに設定する識別子を文字列で指定する。
vtbl 9 HRESULT get_SubscriptionName(LPWSTR* pbstrSubscriptionName)

サブスクリプションオブジェクトの表示可能な名前です。(Get)

pbstrSubscriptionNameLPWSTR*outサブスクリプションの名前を文字列として受け取る。
vtbl 10 HRESULT put_SubscriptionName(LPWSTR bstrSubscriptionName)

サブスクリプションオブジェクトの表示可能な名前です。(Put)

bstrSubscriptionNameLPWSTRinサブスクリプションに設定する名前を文字列で指定する。
vtbl 11 HRESULT get_PublisherID(LPWSTR* pbstrPublisherID)

イベントパブリッシャーの一意な ID です。(Get)

pbstrPublisherIDLPWSTR*outサブスクライブ対象のパブリッシャーの識別子を文字列として受け取る。

解説(Remarks)

PublisherID プロパティを指定しても、サブスクライバーが他のパブリッシャーによって発行されたイベントを受け取らないことが保証されるわけではありません。

vtbl 12 HRESULT put_PublisherID(LPWSTR bstrPublisherID)

イベントパブリッシャーの一意な ID です。(Put)

bstrPublisherIDLPWSTRinサブスクライブ対象のパブリッシャーの識別子を文字列で指定する。

解説(Remarks)

PublisherID プロパティを指定しても、サブスクライバーが他のパブリッシャーによって発行されたイベントを受け取らないことが保証されるわけではありません。

vtbl 13 HRESULT get_EventClassID(LPWSTR* pbstrEventClassID)

サブスクリプションに関連付けられたイベントクラスの一意な ID です。(Get)

pbstrEventClassIDLPWSTR*outサブスクライブ対象のイベントクラスの識別子を文字列として受け取る。
vtbl 14 HRESULT put_EventClassID(LPWSTR bstrEventClassID)

サブスクリプションに関連付けられたイベントクラスの一意な ID です。(Put)

bstrEventClassIDLPWSTRinサブスクライブ対象のイベントクラスの識別子を文字列で指定する。
vtbl 15 HRESULT get_MethodName(LPWSTR* pbstrMethodName)

イベントメソッドの名前です。(Get)

pbstrMethodNameLPWSTR*outサブスクライブ対象のメソッド名を文字列として受け取る。
vtbl 16 HRESULT put_MethodName(LPWSTR bstrMethodName)

イベントメソッドの名前です。(Put)

bstrMethodNameLPWSTRinサブスクライブ対象のメソッド名を文字列で指定する。
vtbl 17 HRESULT get_SubscriberCLSID(LPWSTR* pbstrSubscriberCLSID)

サブスクライバーコンポーネントの CLSID です(永続サブスクリプションの場合)。(Get)

pbstrSubscriberCLSIDLPWSTR*outサブスクライバーオブジェクトの CLSID を文字列として受け取る。

解説(Remarks)

空でない場合、サブスクリプションは永続的であり、SubscriberInterface プロパティは NULL でなければなりません。このプロパティは、永続サブスクリプションにおいて MachineName プロパティと連携して機能します。

vtbl 18 HRESULT put_SubscriberCLSID(LPWSTR bstrSubscriberCLSID)

サブスクライバーコンポーネントの CLSID です(永続サブスクリプションの場合)。(Put)

bstrSubscriberCLSIDLPWSTRinサブスクライバーオブジェクトの CLSID を文字列で指定する。

解説(Remarks)

空でない場合、サブスクリプションは永続的であり、SubscriberInterface プロパティは NULL でなければなりません。このプロパティは、永続サブスクリプションにおいて MachineName プロパティと連携して機能します。

vtbl 19 HRESULT get_SubscriberInterface(IUnknown** ppSubscriberInterface)

サブスクライバー上のイベントインターフェイスへのマーシャリングされたポインターです(一時サブスクリプションの場合)。(Get)

ppSubscriberInterfaceIUnknown**outサブスクライバーのインターフェイスへのポインタを受け取るポインタである。

解説(Remarks)

NULL でない場合、サブスクリプションは一時的であり、SubscriberCLSID プロパティは空でなければなりません。

vtbl 20 HRESULT put_SubscriberInterface(IUnknown* pSubscriberInterface)

サブスクライバー上のイベントインターフェイスへのマーシャリングされたポインターです(一時サブスクリプションの場合)。(Put)

pSubscriberInterfaceIUnknown*inサブスクライバーのインターフェイスへのポインタを指定する。

解説(Remarks)

NULL でない場合、サブスクリプションは一時的であり、SubscriberCLSID プロパティは空でなければなりません。

vtbl 21 HRESULT get_PerUser(BOOL* pfPerUser)

サブスクリプションの所有者がパブリッシャーと同じコンピューターにログオンしている場合にのみ、サブスクリプションがイベントを受け取るかどうかを示します。(Get)

pfPerUserBOOL*outサブスクリプションがユーザー単位であるかどうかを受け取る。
vtbl 22 HRESULT put_PerUser(BOOL fPerUser)

サブスクリプションの所有者がパブリッシャーと同じコンピューターにログオンしている場合にのみ、サブスクリプションがイベントを受け取るかどうかを示します。(Put)

fPerUserBOOLinサブスクリプションをユーザー単位とするかどうかを指定する。
vtbl 23 HRESULT get_OwnerSID(LPWSTR* pbstrOwnerSID)

サブスクリプションの作成者のセキュリティ ID です。(Get)

pbstrOwnerSIDLPWSTR*outサブスクリプションの所有者を表す SID を文字列として受け取る。
vtbl 24 HRESULT put_OwnerSID(LPWSTR bstrOwnerSID)

サブスクリプションの作成者のセキュリティ ID です。(Put)

bstrOwnerSIDLPWSTRinサブスクリプションの所有者を表す SID を文字列で指定する。
vtbl 25 HRESULT get_Enabled(BOOL* pfEnabled)

サブスクリプションが有効かどうかを示します。(Get)

pfEnabledBOOL*outサブスクリプションが有効かどうかを受け取る。

解説(Remarks)

サブスクリプションが有効でない場合でも、コレクションには表示され、クエリの対象にもなりますが、パブリッシャーによって発行されたイベントはサブスクライバーに届きません。

vtbl 26 HRESULT put_Enabled(BOOL fEnabled)

サブスクリプションが有効かどうかを示します。(Put)

fEnabledBOOLinサブスクリプションを有効にするかどうかを指定する。

解説(Remarks)

サブスクリプションが有効でない場合でも、コレクションには表示され、クエリの対象にもなりますが、パブリッシャーによって発行されたイベントはサブスクライバーに届きません。

vtbl 27 HRESULT get_Description(LPWSTR* pbstrDescription)

サブスクリプションの表示可能なテキスト説明です。(Get)

pbstrDescriptionLPWSTR*outサブスクリプションの説明文字列を受け取る。
vtbl 28 HRESULT put_Description(LPWSTR bstrDescription)

サブスクリプションの表示可能なテキスト説明です。(Put)

bstrDescriptionLPWSTRinサブスクリプションに設定する説明文字列を指定する。
vtbl 29 HRESULT get_MachineName(LPWSTR* pbstrMachineName)

サブスクライバーをアクティブ化すべきコンピューターの名前です(永続サブスクリプションの場合)。(Get)

pbstrMachineNameLPWSTR*outサブスクリプションが対象とするマシン名を文字列として受け取る。

解説(Remarks)

この情報は、SubscriberCLSID プロパティが空でない場合にのみ意味を持ちます。このプロパティは一時サブスクリプションには影響しません。

vtbl 30 HRESULT put_MachineName(LPWSTR bstrMachineName)

サブスクライバーをアクティブ化すべきコンピューターの名前です(永続サブスクリプションの場合)。(Put)

bstrMachineNameLPWSTRinサブスクリプションが対象とするマシン名を文字列で指定する。

解説(Remarks)

この情報は、SubscriberCLSID プロパティが空でない場合にのみ意味を持ちます。このプロパティは一時サブスクリプションには影響しません。

vtbl 31 HRESULT GetPublisherProperty(LPWSTR bstrPropertyName, VARIANT* propertyValue)

パブリッシャーコンテキストを定義するためにプロパティバッグに格納されたプロパティの値を取得します。

bstrPropertyNameLPWSTRin要求するプロパティの名前です。
propertyValueVARIANT*out要求したプロパティの値です。

戻り値

このメソッドは、標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED、E_FAIL、および S_OK を返すことがあります。

解説(Remarks)

パブリッシャーフィルターは、サブスクリプションビルダーによって格納されたフィルタープロパティを取得するために、このメソッドを呼び出す必要があります。

vtbl 32 HRESULT PutPublisherProperty(LPWSTR bstrPropertyName, VARIANT* propertyValue)

パブリッシャーコンテキストを定義するために、プロパティとその値をプロパティバッグに書き込みます。

bstrPropertyNameLPWSTRin値をプロパティバッグに書き込むプロパティの名前です。プロパティがプロパティバッグに存在しない場合、このメソッドはそれを追加します。
propertyValueVARIANT*inプロパティバッグに書き込むプロパティの値です。プロパティが既にプロパティバッグに存在する場合、このメソッドは現在の値を上書きします。

戻り値

このメソッドは、標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED、E_FAIL、および S_OK を返すことがあります。

解説(Remarks)

プロパティバッグは、サブスクライバーが通知を必要とするイベントに関する情報を格納するために使用されます。たとえば、スポーツティッカーのサブスクライバーが野球のスコアのみを取得したい場合、サブスクリプションオブジェクト内のプロパティバッグを使用してこの制限を指定できます。

vtbl 33 HRESULT RemovePublisherProperty(LPWSTR bstrPropertyName)

パブリッシャーコンテキストを定義するプロパティバッグから、プロパティとその値を削除します。

bstrPropertyNameLPWSTRin値をプロパティバッグから削除するプロパティの名前です。

戻り値

このメソッドは、標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED、E_FAIL、および S_OK を返すことがあります。

解説(Remarks)

プロパティバッグは、サブスクライバーが通知を必要とするイベントに関する情報を格納するために使用されます。たとえば、スポーツティッカーのサブスクライバーが野球のスコアのみを取得したい場合、サブスクリプションオブジェクト内のプロパティバッグを使用してこの制限を指定できます。

vtbl 34 HRESULT GetPublisherPropertyCollection(IEventObjectCollection** collection)

パブリッシャーのプロパティバッグに格納されたプロパティと値のコレクションを取得します。

collectionIEventObjectCollection**outイベントオブジェクトコレクション上の IEventObjectCollection インターフェイスへのポインターのアドレスです。このパラメーターを NULL にすることはできません。

戻り値

このメソッドは、標準の戻り値 E_INVALIDARG、E_POINTER、E_OUTOFMEMORY、E_UNEXPECTED、E_FAIL、および S_OK を返すことがあります。

解説(Remarks)

プロパティバッグは、サブスクライバーが通知を必要とするイベントに関する情報を格納するために使用されます。たとえば、スポーツティッカーのサブスクライバーが野球のスコアのみを取得したい場合、サブスクリプションオブジェクト内のプロパティバッグを使用してこの制限を指定できます。

vtbl 35 HRESULT GetSubscriberProperty(LPWSTR bstrPropertyName, VARIANT* propertyValue)

サブスクライバーコンテキストを定義するためにプロパティバッグに格納されたプロパティの値を取得します。

bstrPropertyNameLPWSTRin要求するプロパティの名前です。
propertyValueVARIANT*out要求したプロパティの値です。

戻り値

このメソッドは、標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED、E_FAIL、および S_OK を返すことがあります。

vtbl 36 HRESULT PutSubscriberProperty(LPWSTR bstrPropertyName, VARIANT* propertyValue)

サブスクライバーコンテキストを定義するために、プロパティとその値をプロパティバッグに書き込みます。

bstrPropertyNameLPWSTRin値をプロパティバッグに書き込むプロパティの名前です。プロパティがプロパティバッグに存在しない場合、このメソッドはそれを追加します。
propertyValueVARIANT*inプロパティバッグに書き込むプロパティの値です。プロパティが既にプロパティバッグに存在する場合、このメソッドは現在の値を上書きします。

戻り値

このメソッドは、標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED、E_FAIL、および S_OK を返すことがあります。

解説(Remarks)

プロパティバッグは、サブスクライバーが通知を必要とするイベントに関する情報を格納するために使用されます。たとえば、スポーツティッカーのサブスクライバーが野球のスコアのみを取得したい場合、サブスクリプションオブジェクト内のプロパティバッグを使用してこの制限を指定できます。

vtbl 37 HRESULT RemoveSubscriberProperty(LPWSTR bstrPropertyName)

サブスクライバーコンテキストを定義するプロパティバッグから、プロパティとその値を削除します。

bstrPropertyNameLPWSTRin値をプロパティバッグから削除するプロパティの名前です。

戻り値

このメソッドは、標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED、E_FAIL、および S_OK を返すことがあります。

vtbl 38 HRESULT GetSubscriberPropertyCollection(IEventObjectCollection** collection)

サブスクライバーのプロパティバッグに格納されたプロパティと値のコレクションを取得します。

collectionIEventObjectCollection**outイベントオブジェクトコレクション上の IEventObjectCollection インターフェイスへのポインターのアドレスです。このパラメーターを NULL にすることはできません。

戻り値

このメソッドは、標準の戻り値 E_INVALIDARG、E_POINTER、E_OUTOFMEMORY、E_UNEXPECTED、E_FAIL、および S_OK を返すことがあります。

解説(Remarks)

プロパティバッグは、サブスクライバーが通知を必要とするイベントに関する情報を格納するために使用されます。たとえば、スポーツティッカーのサブスクライバーが野球のスコアのみを取得したい場合、サブスクリプションオブジェクト内のプロパティバッグを使用してこの制限を指定できます。

vtbl 39 HRESULT get_InterfaceID(LPWSTR* pbstrInterfaceID)

サブスクライバーがイベントを受け取りたい特定のインターフェイスの識別子です。(Get)

pbstrInterfaceIDLPWSTR*outサブスクライブ対象のインターフェイス ID を文字列として受け取る。
vtbl 40 HRESULT put_InterfaceID(LPWSTR bstrInterfaceID)

サブスクライバーがイベントを受け取りたい特定のインターフェイスの識別子です。(Put)

bstrInterfaceIDLPWSTRinサブスクライブ対象のインターフェイス ID を文字列で指定する。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数: 
#define global IID_IEventSubscription "{4A6B0E15-2E38-11D1-9965-00C04FBBB345}"
#usecom global IEventSubscription IID_IEventSubscription "{}"
#comfunc global IEventSubscription_get_SubscriptionID               7 var
#comfunc global IEventSubscription_put_SubscriptionID               8 wstr
#comfunc global IEventSubscription_get_SubscriptionName             9 var
#comfunc global IEventSubscription_put_SubscriptionName             10 wstr
#comfunc global IEventSubscription_get_PublisherID                  11 var
#comfunc global IEventSubscription_put_PublisherID                  12 wstr
#comfunc global IEventSubscription_get_EventClassID                 13 var
#comfunc global IEventSubscription_put_EventClassID                 14 wstr
#comfunc global IEventSubscription_get_MethodName                   15 var
#comfunc global IEventSubscription_put_MethodName                   16 wstr
#comfunc global IEventSubscription_get_SubscriberCLSID              17 var
#comfunc global IEventSubscription_put_SubscriberCLSID              18 wstr
#comfunc global IEventSubscription_get_SubscriberInterface          19 sptr
#comfunc global IEventSubscription_put_SubscriberInterface          20 sptr
#comfunc global IEventSubscription_get_PerUser                      21 var
#comfunc global IEventSubscription_put_PerUser                      22 int
#comfunc global IEventSubscription_get_OwnerSID                     23 var
#comfunc global IEventSubscription_put_OwnerSID                     24 wstr
#comfunc global IEventSubscription_get_Enabled                      25 var
#comfunc global IEventSubscription_put_Enabled                      26 int
#comfunc global IEventSubscription_get_Description                  27 var
#comfunc global IEventSubscription_put_Description                  28 wstr
#comfunc global IEventSubscription_get_MachineName                  29 var
#comfunc global IEventSubscription_put_MachineName                  30 wstr
#comfunc global IEventSubscription_GetPublisherProperty             31 wstr,var
#comfunc global IEventSubscription_PutPublisherProperty             32 wstr,var
#comfunc global IEventSubscription_RemovePublisherProperty          33 wstr
#comfunc global IEventSubscription_GetPublisherPropertyCollection   34 sptr
#comfunc global IEventSubscription_GetSubscriberProperty            35 wstr,var
#comfunc global IEventSubscription_PutSubscriberProperty            36 wstr,var
#comfunc global IEventSubscription_RemoveSubscriberProperty         37 wstr
#comfunc global IEventSubscription_GetSubscriberPropertyCollection  38 sptr
#comfunc global IEventSubscription_get_InterfaceID                  39 var
#comfunc global IEventSubscription_put_InterfaceID                  40 wstr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。