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

ISelectionProvider

COM
📘 Microsoft Learn (日本語) · English
IIDfb8b03af-3bdf-48d4-bd36-1a65793be168継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

個別に選択可能な子項目のコレクションのコンテナーとして機能するコントロールへのアクセスを提供します。

解説(Remarks)

このインターフェイスは UI Automation プロバイダーによって実装されます。

コンテナー内の選択内容が大きく変化した場合、プロバイダーは UIA_Selection_InvalidatedEventId 型のイベントを発生させる必要があります。

メソッド 3

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

vtbl 3 HRESULT GetSelection(SAFEARRAY** pRetVal)

選択されている各子要素に対する Microsoft UI Automation プロバイダーを取得します。

pRetValSAFEARRAY**out選択された要素の IRawElementProviderSimple インターフェイスへのポインターの配列を格納する SAFEARRAY へのポインターを受け取ります。このパラメーターは初期化されていない状態で渡されます。

戻り値

型: HRESULT

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

vtbl 4 HRESULT get_CanSelectMultiple(BOOL* pRetVal)

Microsoft UI Automation プロバイダーが複数の子要素を同時に選択できるようにするかどうかを示します。

pRetValBOOL*outコンテナーが複数項目の同時選択をサポートするかどうかを受け取る BOOL へのポインタである。

解説(Remarks)

このプロパティは動的である場合があります。たとえば、まれにコントロールが初期化時には複数の項目の選択を許可し、その後は単一の選択のみを許可することがあります。

vtbl 5 HRESULT get_IsSelectionRequired(BOOL* pRetVal)

Microsoft UI Automation プロバイダーが少なくとも 1 つの子要素の選択を必要とするかどうかを示します。

pRetValBOOL*outコンテナーで常に少なくとも 1 つの項目の選択が必須かどうかを受け取る BOOL へのポインタである。

解説(Remarks)

このプロパティは動的である場合があります。たとえば、コントロールの初期状態では既定でどの項目も選択されておらず、ISelectionProvider::IsSelectionRequired が FALSE であることがあります。しかし、いったん項目が選択されると、そのコントロールは常に少なくとも 1 つの項目が選択されている必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ISelectionProvider "{FB8B03AF-3BDF-48D4-BD36-1A65793BE168}"
#usecom global ISelectionProvider IID_ISelectionProvider "{}"
#comfunc global ISelectionProvider_GetSelection             3 var
#comfunc global ISelectionProvider_get_CanSelectMultiple    4 var
#comfunc global ISelectionProvider_get_IsSelectionRequired  5 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。