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

IItemContainerProvider

COM
IIDe747770b-39ce-4382-ab30-d8fb3f336f24継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

仮想リストビューなど、他のコントロールのコンテナーとして機能するコントロールへのアクセスを提供します。

解説(Remarks)

ItemContainer コントロールパターンを使用すると、コンテナーオブジェクトは Name、AutomationId、IsSelected 状態などの指定されたオートメーション要素プロパティによって、項目を効率的に検索できます。このコントロールパターンは仮想化されたコンテナーで使用されることを念頭に導入されていますが、コンテナーが仮想化を使用するかどうかにかかわらず、名前による検索を提供する任意のコンテナーで実装できます。

メソッド 1

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

vtbl 3 HRESULT FindItemByProperty(IRawElementProviderSimple* pStartAfter, UIA_PROPERTY_ID propertyId, VARIANT value, IRawElementProviderSimple** pFound)

指定されたプロパティ値に基づいて、コンテナー要素内の要素を取得します。(IItemContainerProvider.FindItemByProperty)

pStartAfterIRawElementProviderSimple*in検索を開始する起点となる要素の UI Automation プロバイダー。すべての要素を検索する場合は NULL を指定します。
propertyIdUIA_PROPERTY_IDinプロパティ識別子。プロパティ ID の一覧については、Property Identifiers を参照してください。
valueVARIANTinプロパティの値。
pFoundIRawElementProviderSimple**out要素の UI Automation プロバイダーへのポインターを受け取ります。

戻り値

型: HRESULT

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

解説(Remarks)

仮想リストの場合、返される要素はプレースホルダーである可能性があります。その場合は IVirtualizedItemProvider::Realize を使用して、項目を完全に利用可能にできます。

指定されたプロパティによる検索がサポートされていない場合、このメソッドは E_INVALIDARG を返します。ほとんどのコンテナーは UIA_NamePropertyId をサポートすべきであり、適切な場合は UIA_AutomationIdPropertyId および UIA_SelectionItemIsSelectedPropertyId もサポートすべきです。

propertyId が 0 の場合、すべての項目が一致とみなされます。この値を pStartAfterNULL を指定して使用すると最初の項目を取得でき、続けて後続の項目を取得できます。この場合、valueVT_EMPTY にする必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IItemContainerProvider "{E747770B-39CE-4382-AB30-D8FB3F336F24}"
#usecom global IItemContainerProvider IID_IItemContainerProvider "{}"
#comfunc global IItemContainerProvider_FindItemByProperty  3 sptr,int,int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。