IUIAutomation3

COM

IID73d768da-9b51-4b89-936e-c209290973e7継承元IUIAutomation2自前メソッド開始 vtbl64

公式ドキュメント

IUIAutomation2 インターフェイスを拡張し、Microsoft UI Automation 機能を制御するための追加メソッドを公開します。

メソッド 2

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

vtbl 64 HRESULT AddTextEditTextChangedEventHandler(IUIAutomationElement* element, TreeScope scope, TextEditChangeType textEditChangeType, IUIAutomationCacheRequest* cacheRequest, IUIAutomationTextEditTextChangedEventHandler* handler)

プログラムによるテキスト編集イベントを処理するメソッドを登録します。注意イベントハンドラーを実装する前に、「Understanding Threading Issues」で説明されているスレッド処理の問題を理解しておく必要があります。

element	IUIAutomationElement*	in	イベントハンドラーに関連付けられる UI Automation 要素へのポインター。
scope	TreeScope	in	処理するイベントのスコープ。すなわち、イベントが要素自体に対するものか、その先祖および子孫に対するものかを指定します。
textEditChangeType	TextEditChangeType	in	リッスンする特定の変更の種類。クライアントはテキスト編集の変更の種類ごとに個別に登録します。これにより、UI Automation システムは実行時に登録済みのリスナーを確認でき、リスナーが存在しない場合に特定のテキスト編集変更に対するイベントを発生させないようにできます。
cacheRequest	IUIAutomationCacheRequest*	in	キャッシュ要求へのポインター。キャッシュが不要な場合は NULL。
handler	IUIAutomationTextEditTextChangedEventHandler*	in	プログラムによるテキスト編集イベントを処理するオブジェクトへのポインター。

戻り値

型: HRESULT

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

解説(Remarks)

UI Automation クライアントは、イベントハンドラーの追加や削除に複数のスレッドを使用しないでください。同一クライアントプロセス内で、あるイベントハンドラーの追加または削除が行われている最中に別のイベントハンドラーの追加または削除が行われると、予期しない動作が発生する可能性があります。

vtbl 65 HRESULT RemoveTextEditTextChangedEventHandler(IUIAutomationElement* element, IUIAutomationTextEditTextChangedEventHandler* handler)

プログラムによるテキスト編集イベントハンドラーを削除します。

element	IUIAutomationElement*	in	ハンドラーを削除する対象の UI Automation 要素へのポインター。
handler	IUIAutomationTextEditTextChangedEventHandler*	in	IUIAutomation3::AddTextEditTextChangedEventHandler に渡されたインターフェイスへのポインター。

戻り値

型: HRESULT

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

解説(Remarks)

Microsoft UI Automation クライアントは、イベントハンドラーの追加や削除に複数のスレッドを使用しないでください。同一クライアントプロセス内で、あるイベントハンドラーの追加または削除が行われている最中に別のイベントハンドラーの追加または削除が行われると、予期しない動作が発生する可能性があります。

イベントの登録解除要求とイベントの受信が同時に発生した場合、ハンドラーの登録解除後にイベントがイベントハンドラーに配信される可能性があります。ベストプラクティスは、Component Object Model (COM) の標準に従い、参照カウントがゼロに達するまでイベントハンドラーオブジェクトを破棄しないことです。イベントの登録解除の直後にイベントハンドラーを破棄すると、イベントが遅れて配信された場合にアクセス違反が発生する可能性があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IUIAutomation3 "{73D768DA-9B51-4B89-936E-C209290973E7}"
#usecom global IUIAutomation3 IID_IUIAutomation3 "{}"
#comfunc global IUIAutomation3_AddTextEditTextChangedEventHandler     64 sptr,int,int,sptr,sptr
#comfunc global IUIAutomation3_RemoveTextEditTextChangedEventHandler  65 sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。