ホーム › UI.Accessibility › IUIAutomationTextRange3

IUIAutomationTextRange3

COM

IID6a315d69-5512-4c2e-85f0-53fce6dd4bc2継承元IUIAutomationTextRange2自前メソッド開始 vtbl22

公式ドキュメント

IUIAutomationTextRange2 インターフェースを拡張し、テキスト範囲の基になるリッチテキストデータへのより高速なアクセスをサポートします。

メソッド 3

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

vtbl 22 HRESULT GetEnclosingElementBuildCache(IUIAutomationCacheRequest* cacheRequest, IUIAutomationElement** enclosingElement)

テキスト範囲内の要素について、その要素を包含する要素と、指定されたプロパティおよびパターンを、1 回のプロセス間呼び出しで取得します。これは GetEnclosingElement を呼び出すことと同等ですが、標準のビルドキャッシュパターンが追加されています。

cacheRequest	IUIAutomationCacheRequest*	in	キャッシュするプロパティおよびコントロールパターンを指定する IUIAutomationCacheRequest。
enclosingElement	IUIAutomationElement**	out	指定された cacheRequest の条件を満たす場合、テキスト範囲を包含する要素(およびそのプロパティ/パターン)を返します。

戻り値

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

解説(Remarks)

GetEnclosingElement の設計に従います。

テキスト範囲を包含する、すべてを含む最も内側の要素と、その要素の指定されたプロパティを取得します。

呼び出しが成功すると、UI Automation クライアントは cacheRequest で指定された IUIAutomationElement の「キャッシュ済み」API(たとえば IUIAutomationElement::GetCachedPropertyValue)を呼び出せるようになります。

vtbl 23 HRESULT GetChildrenBuildCache(IUIAutomationCacheRequest* cacheRequest, IUIAutomationElementArray** children)

テキスト範囲内の要素について、子要素と、指定されたプロパティおよびパターンを、1 回のプロセス間呼び出しで返します。これは GetChildren を呼び出すことと同等ですが、標準のビルドキャッシュパターンが追加されています。

cacheRequest	IUIAutomationCacheRequest*	in	キャッシュするプロパティおよびコントロールパターンを指定する IUIAutomationCacheRequest。
children	IUIAutomationElementArray**	out	指定された cacheRequest の条件を満たす、テキスト範囲の子要素と、各子要素のプロパティまたはパターンを返します。

戻り値

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

解説(Remarks)

GetChildren の設計に従います。

テキスト範囲と重なっているものの、完全には包含されていない子要素も含まれます。
子要素が存在しない場合は、空のコレクションが返されます。

vtbl 24 HRESULT GetAttributeValues(UIA_TEXTATTRIBUTE_ID* attributeIds, INT attributeIdCount, SAFEARRAY** attributeValues)

テキスト範囲について、要求されたすべてのテキスト属性値を、1 回のプロセス間呼び出しで返します。これは GetAttributeValue を呼び出すことと同等ですが、1 つだけでなく複数の値を取得できる点が異なります。

attributeIds	UIA_TEXTATTRIBUTE_ID*	in	テキスト属性識別子のリスト。
attributeIdCount	INT	in	attributeIds リスト内のテキスト属性識別子の数。
attributeValues	SAFEARRAY**	out	テキスト範囲の対応するテキスト属性の値を格納した、VARIANT の SAFEARRAY。

戻り値

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

解説(Remarks)

GetAttributeValues は、呼び出しで指定されたテキスト属性のみを取得します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IUIAutomationTextRange3 "{6A315D69-5512-4C2E-85F0-53FCE6DD4BC2}"
#usecom global IUIAutomationTextRange3 IID_IUIAutomationTextRange3 "{}"
#comfunc global IUIAutomationTextRange3_GetEnclosingElementBuildCache  22 sptr,sptr
#comfunc global IUIAutomationTextRange3_GetChildrenBuildCache          23 sptr,sptr
#comfunc global IUIAutomationTextRange3_GetAttributeValues             24 var,int,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IUIAutomationTextRange3 "{6A315D69-5512-4C2E-85F0-53FCE6DD4BC2}"
#usecom global IUIAutomationTextRange3 IID_IUIAutomationTextRange3 "{}"
#comfunc global IUIAutomationTextRange3_GetEnclosingElementBuildCache  22 sptr,sptr
#comfunc global IUIAutomationTextRange3_GetChildrenBuildCache          23 sptr,sptr
#comfunc global IUIAutomationTextRange3_GetAttributeValues             24 sptr,int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。