IUIAutomationItemContainerPattern
COM公式ドキュメント
仮想リストなどのコンテナーから項目を取得するメソッドを公開します。
解説(Remarks)
このインターフェースは仮想化されたコンテナーでの使用に限定されません。効率的な名前検索を実装できるコンテナーであれば、このコントロールパターンをサポートでき、Microsoft UI Automation ツリーを走査する必要がある FindFirst などのメソッドを使用するよりも、クライアントが名前を高速に検索できるようになります。
メソッド 1
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
指定したプロパティ値に基づいて、コンテナー要素内の要素を取得します。(IUIAutomationItemContainerPattern.FindItemByProperty)
| pStartAfter | IUIAutomationElement* | in | 検索を開始する起点となる要素へのポインター。すべての要素を検索する場合は NULL を指定します。 |
| propertyId | UIA_PROPERTY_ID | in | プロパティ識別子。プロパティ ID の一覧については、Property Identifiers を参照してください。 |
| value | VARIANT | in | プロパティ値。 |
| pFound | IUIAutomationElement** | out | 一致した要素へのポインターを受け取ります。 |
戻り値
解説(Remarks)
プロバイダーは、一致する要素が仮想化されている場合、実際の IUIAutomationElement インターフェース、またはプレースホルダーを返すことがあります。
このメソッドは、要求されたプロパティがコンテナーの検索対象としてサポートされていない場合、E_INVALIDARG を返します。ほとんどのコンテナーは Name プロパティをサポートすることが期待され、コンテナーに適している場合は AutomationId と IsSelected もサポートします。
このメソッドは、一致するものを見つけるために複数のオブジェクトを走査する必要がある場合があるため、低速になることがあります。ループ内で複数の項目を返すために使用する場合、各項目が一度だけ返される限り(すなわちループが終了する限り)、特定の順序は定義されていません。またこのメソッドは UI 中心ではなく項目中心であるため、複数の UI 表現を持つ項目は一度だけヒットさせる必要があります。
propertyId パラメーターに 0(ゼロ)を指定した場合、プロバイダーは pStartAfter の次の項目を返すことが期待されます。pStartAfter に NULL、propertyId に 0 を指定した場合、プロバイダーはコンテナー内の最初の項目を返す必要があります。propertyId に 0 を指定した場合、value パラメーターは VT_EMPTY にする必要があります。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IUIAutomationItemContainerPattern "{C690FDB2-27A8-423C-812D-429773C9084E}"
#usecom global IUIAutomationItemContainerPattern IID_IUIAutomationItemContainerPattern "{}"
#comfunc global IUIAutomationItemContainerPattern_FindItemByProperty 3 sptr,int,int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。