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

IUIAutomationElement7

COM
IID204e8572-cfc3-4c11-b0c8-7da7420750b7継承元IUIAutomationElement6自前メソッド開始 vtbl110

公式ドキュメント

IUIAutomationElement6 インターフェイスを拡張します。

メソッド 5

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

vtbl 110 HRESULT FindFirstWithOptions(TreeScope scope, IUIAutomationCondition* condition, TreeTraversalOptions traversalOptions, IUIAutomationElement* root, IUIAutomationElement** found)

指定した順序で最初に一致する要素を検索します。

scopeTreeScopein検索の範囲を指定する値の組み合わせです。
conditionIUIAutomationCondition*in一致条件を表す condition へのポインターです。
traversalOptionsTreeTraversalOptionsinツリーのナビゲーション順序を指定する列挙値です。
rootIUIAutomationElement*in検索を開始する要素へのポインターです。
foundIUIAutomationElement**out要素へのポインターを受け取ります。一致する要素が見つからない場合は NULL が返されます。

戻り値

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

vtbl 111 HRESULT FindAllWithOptions(TreeScope scope, IUIAutomationCondition* condition, TreeTraversalOptions traversalOptions, IUIAutomationElement* root, IUIAutomationElementArray** found)

指定した順序で一致するすべての要素を検索します。

scopeTreeScopein検索の範囲を指定する値の組み合わせです。
conditionIUIAutomationCondition*in一致条件を表す condition へのポインターです。
traversalOptionsTreeTraversalOptionsinツリーのナビゲーション順序を指定する列挙値です。
rootIUIAutomationElement*in検索を開始する要素へのポインターです。
foundIUIAutomationElementArray**out一致する要素の配列へのポインターを受け取ります。一致する要素が見つからない場合は空の配列を返します。

戻り値

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

vtbl 112 HRESULT FindFirstWithOptionsBuildCache(TreeScope scope, IUIAutomationCondition* condition, IUIAutomationCacheRequest* cacheRequest, TreeTraversalOptions traversalOptions, IUIAutomationElement* root, IUIAutomationElement** found)

指定した順序で最初に一致する要素を検索し、さらにそのプロパティとパターンをキャッシュします。

scopeTreeScopein検索の範囲を指定する値の組み合わせです。
conditionIUIAutomationCondition*in一致条件を表す condition へのポインターです。
cacheRequestIUIAutomationCacheRequest*inキャッシュに含めるコントロールパターンとプロパティを指定する cache request へのポインターです。
traversalOptionsTreeTraversalOptionsinツリーのナビゲーション順序を指定する列挙値です。
rootIUIAutomationElement*in検索を開始する要素へのポインターです。
foundIUIAutomationElement**out要素へのポインターを受け取ります。一致する要素が見つからない場合は NULL が返されます。

戻り値

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

vtbl 113 HRESULT FindAllWithOptionsBuildCache(TreeScope scope, IUIAutomationCondition* condition, IUIAutomationCacheRequest* cacheRequest, TreeTraversalOptions traversalOptions, IUIAutomationElement* root, IUIAutomationElementArray** found)

指定した順序で一致するすべての要素を検索し、さらにそれらのプロパティとパターンをキャッシュします。

scopeTreeScopein

要求の範囲です。

要素を取得する際、キャッシュは要素自体のみ(既定の動作)、または要素とその子孫を対象に実行できます。このプロパティは要求の範囲を表します。

conditionIUIAutomationCondition*inUI Automation ツリー内で要素を検索する際のフィルター処理に使用される condition の主要インターフェイスです。
cacheRequestIUIAutomationCacheRequest*inキャッシュに含めるコントロールパターンとプロパティを指定する cache request へのポインターです。
traversalOptionsTreeTraversalOptionsinツリーのナビゲーション順序です。
rootIUIAutomationElement*in検索を開始する要素へのポインターです。
foundIUIAutomationElementArray**out一致する要素の配列へのポインターを受け取ります。一致する要素が見つからない場合は空の配列を返します。

戻り値

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

vtbl 114 HRESULT GetCurrentMetadataValue(INT targetId, UIA_METADATA_ID metadataId, VARIANT* returnVal)

情報をどのように解釈すべきかを示すメタデータを UI Automation 要素から取得します。(IUIAutomationElement7.GetCurrentMetadataValue)

targetIdINTin取得するプロパティの ID です。
metadataIdUIA_METADATA_IDin取得するメタデータの種類を指定します。
returnValVARIANT*outメタデータです。

戻り値

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IUIAutomationElement7 "{204E8572-CFC3-4C11-B0C8-7DA7420750B7}"
#usecom global IUIAutomationElement7 IID_IUIAutomationElement7 "{}"
#comfunc global IUIAutomationElement7_FindFirstWithOptions            110 int,sptr,int,sptr,sptr
#comfunc global IUIAutomationElement7_FindAllWithOptions              111 int,sptr,int,sptr,sptr
#comfunc global IUIAutomationElement7_FindFirstWithOptionsBuildCache  112 int,sptr,sptr,int,sptr,sptr
#comfunc global IUIAutomationElement7_FindAllWithOptionsBuildCache    113 int,sptr,sptr,int,sptr,sptr
#comfunc global IUIAutomationElement7_GetCurrentMetadataValue         114 int,int,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。