Win32 API 日本語リファレンス
ホーム › UI.Accessibility › IRawElementProviderAdviseEvents

IRawElementProviderAdviseEvents

COM
📘 Microsoft Learn (日本語) · English
IIDa407b27b-0f6d-4427-9292-473c7bf93258継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

Microsoft UI Automation クライアントアプリケーションが、あるフラグメント上でのイベントの待ち受けを開始または終了したときに、そのフラグメントのルート要素へ通知するために呼び出されるメソッドを公開します。

解説(Remarks)

このインターフェイスの実装は任意です。イベントが実際に待ち受けられているときにのみイベントを発生させることで、パフォーマンスを向上させるために利用できます。

Component Object Model (COM) プログラミングにおける参照カウントの実装と同様に、UI Automation プロバイダーは AdviseEventAdded メソッドと AdviseEventRemoved メソッドを、IUnknown インターフェイスの AddRef メソッドおよび Release メソッドと同様に扱うことが重要です。 特定のイベントまたはプロパティに対して AdviseEventAdded が AdviseEventRemoved よりも多く呼び出されている間は、まだ待ち受けているクライアントが存在するため、プロバイダーは対応するイベントを引き続き発生させる必要があります。あるいは、UI Automation プロバイダーは UiaClientsAreListening 関数を使用して、少なくとも 1 つのクライアントが待ち受けているかどうかを判断し、待ち受けている場合は該当するすべてのイベントを発生させることもできます。

メソッド 2

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT AdviseEventAdded(UIA_EVENT_ID eventId, SAFEARRAY* propertyIDs)

UI Automation クライアントが、プロパティ変更イベントを含む特定のイベントの待ち受けを開始したときに、Microsoft UI Automation プロバイダーへ通知します。

eventIdUIA_EVENT_IDin追加されるイベントの識別子です。イベント ID の一覧については、Event Identifiers を参照してください。
propertyIDsSAFEARRAY*in追加されるプロパティの識別子へのポインター。追加されるイベントリスナーがプロパティイベントを待ち受けていない場合は NULL です。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

このメソッドにより、プロバイダーは実際に待ち受けられているイベントのみを発生させることで、オーバーヘッドを削減できます。

UI Automation プロバイダーは IRawElementProviderAdviseEvents::AdviseEventAdded を、IUnknown インターフェイスの AddRef メソッドと同様に扱うことが重要です。特定のイベントまたはプロパティに対して AdviseEventAdded が AdviseEventRemoved よりも多く呼び出されている間は、まだ待ち受けているクライアントが存在するため、プロバイダーは対応するイベントを引き続き発生させる必要があります。あるいは、UI Automation プロバイダーは UiaClientsAreListening 関数を使用して、少なくとも 1 つのクライアントが待ち受けているかどうかを判断し、待ち受けている場合は該当するすべてのイベントを発生させることもできます。

vtbl 4 HRESULT AdviseEventRemoved(UIA_EVENT_ID eventId, SAFEARRAY* propertyIDs)

UI Automation クライアントが、プロパティ変更イベントを含む特定のイベントの待ち受けを停止したときに、Microsoft UI Automation プロバイダーへ通知します。

eventIdUIA_EVENT_IDin削除されるイベントの識別子です。イベント ID の一覧については、Event Identifiers を参照してください。
propertyIDsSAFEARRAY*in削除されるプロパティの識別子へのポインター。削除されるイベントリスナーがプロパティイベントを待ち受けていない場合は NULL です。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

このメソッドにより、プロバイダーは実際に待ち受けられているイベントのみを発生させることで、オーバーヘッドを削減できます。

UI Automation プロバイダーは IRawElementProviderAdviseEvents::AdviseEventRemoved を、IUnknown インターフェイスの Release メソッドと同様に扱うことが重要です。特定のイベントまたはプロパティに対して AdviseEventAdded が AdviseEventRemoved よりも多く呼び出されている間は、まだ待ち受けているクライアントが存在するため、プロバイダーは対応するイベントを引き続き発生させる必要があります。あるいは、UI Automation プロバイダーは UiaClientsAreListening 関数を使用して、少なくとも 1 つのクライアントが待ち受けているかどうかを判断し、待ち受けている場合は該当するすべてのイベントを発生させることもできます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IRawElementProviderAdviseEvents "{A407B27B-0F6D-4427-9292-473C7BF93258}"
#usecom global IRawElementProviderAdviseEvents IID_IRawElementProviderAdviseEvents "{}"
#comfunc global IRawElementProviderAdviseEvents_AdviseEventAdded    3 int,var
#comfunc global IRawElementProviderAdviseEvents_AdviseEventRemoved  4 int,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。