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

IUIAutomationCacheRequest

COM
📘 Microsoft Learn (日本語) · English
IIDb32a92b5-bc25-4078-9c08-d7ee95c48e03継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

キャッシュ要求のプロパティとメソッドを公開します。クライアントアプリケーションは、このインターフェイスを使用して、Microsoft UI Automation 要素を取得する際にキャッシュするプロパティおよびコントロールパターンを指定します。

解説(Remarks)

UI Automation を通じてプロパティやコントロールパターンを取得するには、プロセス間呼び出しが必要となり、パフォーマンスが低下する可能性があります。プロパティやコントロールパターンの値をバッチ操作でキャッシュすることにより、アプリケーションのパフォーマンスを向上させることができます。

CreateCacheRequest を呼び出して新しいキャッシュ要求を作成し、IUIAutomationCacheRequest のメソッドを呼び出して要求を構成します。

メソッド 9

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

vtbl 3 HRESULT AddProperty(UIA_PROPERTY_ID propertyId)

キャッシュ要求にプロパティを追加します。

propertyIdUIA_PROPERTY_IDinプロパティ識別子です。プロパティ ID の一覧については、Property Identifiers を参照してください。

戻り値

型: HRESULT

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

vtbl 4 HRESULT AddPattern(UIA_PATTERN_ID patternId)

キャッシュ要求にコントロールパターンを追加します。

patternIdUIA_PATTERN_IDinキャッシュ要求に追加するコントロールパターンの識別子です。コントロールパターン ID の一覧については、Control Pattern Identifiers を参照してください。

戻り値

型: HRESULT

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

解説(Remarks)

既にキャッシュ要求に含まれているコントロールパターンを追加しても効果はありません。

vtbl 5 HRESULT Clone(IUIAutomationCacheRequest** clonedRequest)

キャッシュ要求のコピーを作成します。

clonedRequestIUIAutomationCacheRequest**outキャッシュ要求のコピーへのポインターを受け取ります。

戻り値

型: HRESULT

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

vtbl 6 HRESULT get_TreeScope(TreeScope* scope)

キャッシュの範囲を指定します。(Get)

scopeTreeScope*outキャッシュ対象の範囲(要素自身・子・子孫など)を示す TreeScope 値を受け取るポインタである。

解説(Remarks)

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

vtbl 7 HRESULT put_TreeScope(TreeScope scope)

キャッシュの範囲を指定します。(Put)

scopeTreeScopeinキャッシュ対象とするツリーの範囲を示す TreeScope 値を指定する。

解説(Remarks)

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

vtbl 8 HRESULT get_TreeFilter(IUIAutomationCondition** filter)

キャッシュ時に使用される UI Automation 要素ツリーのビューを指定します。(Get)

filterIUIAutomationCondition**outキャッシュ対象の要素を絞り込む条件を受け取るインターフェイスポインタへのポインタである。
vtbl 9 HRESULT put_TreeFilter(IUIAutomationCondition* filter)

キャッシュ時に使用される UI Automation 要素ツリーのビューを指定します。(Put)

filterIUIAutomationCondition*inキャッシュ対象の要素を絞り込む条件を表す IUIAutomationCondition へのポインタを指定する。
vtbl 10 HRESULT get_AutomationElementMode(AutomationElementMode* mode)

返される要素が基になる UI への完全な参照を含むか、キャッシュされた情報のみを含むかを示します。(Get)

modeAutomationElementMode*outキャッシュされる要素が完全参照かプロパティのみかを示す AutomationElementMode 値を受け取るポインタである。

解説(Remarks)

AutomationElementMode_Full が既定値であり、返される要素が基になる UI への完全な参照を含むことを指定します。AutomationElementMode_None は、返される要素が基になる UI への参照を持たず、キャッシュされた情報のみを含むことを指定します。

GetCurrentPropertyValue や SetFocus を含む要素に対する特定の操作には完全な参照が必要です。参照を持たない要素に対してこれらを実行しようとするとエラーになります。

AutomationElementMode_None を使用すると、完全な参照を設定する際のオーバーヘッドを回避できるため、プロパティのみが必要な場合により効率的です。

vtbl 11 HRESULT put_AutomationElementMode(AutomationElementMode mode)

返される要素が基になる UI への完全な参照を含むか、キャッシュされた情報のみを含むかを示します。(Put)

modeAutomationElementModeinキャッシュされる要素のモード(完全参照かプロパティのみか)を示す AutomationElementMode 値を指定する。

解説(Remarks)

AutomationElementMode_Full が既定値であり、返される要素が基になる UI への完全な参照を含むことを指定します。AutomationElementMode_None は、返される要素が基になる UI への参照を持たず、キャッシュされた情報のみを含むことを指定します。

GetCurrentPropertyValue や SetFocus を含む要素に対する特定の操作には完全な参照が必要です。参照を持たない要素に対してこれらを実行しようとするとエラーになります。

AutomationElementMode_None を使用すると、完全な参照を設定する際のオーバーヘッドを回避できるため、プロパティのみが必要な場合により効率的です。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IUIAutomationCacheRequest "{B32A92B5-BC25-4078-9C08-D7EE95C48E03}"
#usecom global IUIAutomationCacheRequest IID_IUIAutomationCacheRequest "{}"
#comfunc global IUIAutomationCacheRequest_AddProperty                3 int
#comfunc global IUIAutomationCacheRequest_AddPattern                 4 int
#comfunc global IUIAutomationCacheRequest_Clone                      5 sptr
#comfunc global IUIAutomationCacheRequest_get_TreeScope              6 var
#comfunc global IUIAutomationCacheRequest_put_TreeScope              7 int
#comfunc global IUIAutomationCacheRequest_get_TreeFilter             8 sptr
#comfunc global IUIAutomationCacheRequest_put_TreeFilter             9 sptr
#comfunc global IUIAutomationCacheRequest_get_AutomationElementMode  10 var
#comfunc global IUIAutomationCacheRequest_put_AutomationElementMode  11 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。