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

IUIAutomationLegacyIAccessiblePattern

COM
📘 Microsoft Learn (日本語) · English
IID828055ad-355b-4435-86d5-3b51c14a9b1b継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

Microsoft UI Automation クライアントが Microsoft Active Accessibility (MSAA) サーバーから UI 情報を取得できるようにするメソッドとプロパティを公開します。

解説(Remarks)

このインターフェイスは、他のコントロールパターンと同様の方法で取得します。これにより、UI Automation クライアントはキャッシュシステムを活用して MSAA プロパティをより効率的に収集できるようになり、また IAccessible インターフェイスをサポートするネイティブの Microsoft Active Accessibility サーバーとやり取りできるようになります。

メソッド 24

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

vtbl 3 HRESULT Select(INT flagsSelect)

Microsoft Active Accessibility の選択を実行します。(IUIAutomationLegacyIAccessiblePattern.Select)

flagsSelectINTin実行する選択またはフォーカス操作を指定します。このパラメーターには、SELFLAG 定数で説明されている値の組み合わせを指定する必要があります。

戻り値

型: HRESULT

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

vtbl 4 HRESULT DoDefaultAction()

要素に対して Microsoft Active Accessibility の既定のアクションを実行します。(IUIAutomationLegacyIAccessiblePattern.DoDefaultAction)

戻り値

型: HRESULT

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

vtbl 5 HRESULT SetValue(LPWSTR szValue)

要素の Microsoft Active Accessibility の value プロパティを設定します。

szValueLPWSTRinオブジェクトの値を含むローカライズされた文字列。

戻り値

型: HRESULT

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

解説(Remarks)

このメソッドは一部の要素(通常はエディットコントロール)でのみサポートされます。

vtbl 6 HRESULT get_CurrentChildId(INT* pRetVal)

要素の Microsoft Active Accessibility の子識別子を取得します。

pRetValINT*out要素の現在の子 ID を受け取るポインタである。

解説(Remarks)

要素が子要素でない場合は、CHILDID_SELF (0) が返されます。

vtbl 7 HRESULT get_CurrentName(LPWSTR* pszName)

要素の Microsoft Active Accessibility の name プロパティを取得します。

pszNameLPWSTR*out要素の現在の名前を受け取る文字列ポインタへのポインタである。

解説(Remarks)

要素の name は、要素で automation ID プロパティがサポートされていない場合に、要素ツリー内で要素を検索するために使用できます。

vtbl 8 HRESULT get_CurrentValue(LPWSTR* pszValue)

Microsoft Active Accessibility の value プロパティを取得します。

pszValueLPWSTR*out要素の現在の値を受け取る文字列ポインタへのポインタである。
vtbl 9 HRESULT get_CurrentDescription(LPWSTR* pszDescription)

要素の Microsoft Active Accessibility の説明を取得します。

pszDescriptionLPWSTR*out要素の現在の説明を受け取る文字列ポインタへのポインタである。
vtbl 10 HRESULT get_CurrentRole(DWORD* pdwRole)

要素の Microsoft Active Accessibility の role 識別子を取得します。

pdwRoleDWORD*out要素の現在のロール(MSAA ロール定数)を受け取るポインタである。
vtbl 11 HRESULT get_CurrentState(DWORD* pdwState)

要素の Microsoft Active Accessibility の state 識別子を取得します。

pdwStateDWORD*out要素の現在の状態(MSAA 状態フラグ)を受け取るポインタである。
vtbl 12 HRESULT get_CurrentHelp(LPWSTR* pszHelp)

要素の Microsoft Active Accessibility のヘルプ文字列を取得します。

pszHelpLPWSTR*out要素の現在のヘルプ文字列を受け取る文字列ポインタへのポインタである。
vtbl 13 HRESULT get_CurrentKeyboardShortcut(LPWSTR* pszKeyboardShortcut)

要素の Microsoft Active Accessibility のキーボードショートカットプロパティを取得します。

pszKeyboardShortcutLPWSTR*out要素の現在のキーボードショートカット文字列を受け取る文字列ポインタへのポインタである。
vtbl 14 HRESULT GetCurrentSelection(IUIAutomationElementArray** pvarSelectedChildren)

この要素の選択された子を識別する Microsoft Active Accessibility プロパティを取得します。

pvarSelectedChildrenIUIAutomationElementArray**out選択された子要素のコレクションへのポインターを受け取ります。

戻り値

型: HRESULT

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

vtbl 15 HRESULT get_CurrentDefaultAction(LPWSTR* pszDefaultAction)

要素の Microsoft Active Accessibility の現在の既定のアクションを取得します。

pszDefaultActionLPWSTR*out要素の現在の既定アクション文字列を受け取る文字列ポインタへのポインタである。
vtbl 16 HRESULT get_CachedChildId(INT* pRetVal)

要素のキャッシュされた Microsoft Active Accessibility の子識別子を取得します。

pRetValINT*outキャッシュされた要素の子 ID を受け取るポインタである。

解説(Remarks)

要素が子要素でない場合は、CHILDID_SELF (0) が返されます。

vtbl 17 HRESULT get_CachedName(LPWSTR* pszName)

要素のキャッシュされた Microsoft Active Accessibility の name プロパティを取得します。

pszNameLPWSTR*outキャッシュされた要素の名前を受け取る文字列ポインタへのポインタである。
vtbl 18 HRESULT get_CachedValue(LPWSTR* pszValue)

キャッシュされた Microsoft Active Accessibility の value プロパティを取得します。

pszValueLPWSTR*outキャッシュされた要素の値を受け取る文字列ポインタへのポインタである。
vtbl 19 HRESULT get_CachedDescription(LPWSTR* pszDescription)

要素のキャッシュされた Microsoft Active Accessibility の説明を取得します。

pszDescriptionLPWSTR*outキャッシュされた要素の説明を受け取る文字列ポインタへのポインタである。
vtbl 20 HRESULT get_CachedRole(DWORD* pdwRole)

要素のキャッシュされた Microsoft Active Accessibility の role を取得します。

pdwRoleDWORD*outキャッシュされた要素のロール(MSAA ロール定数)を受け取るポインタである。
vtbl 21 HRESULT get_CachedState(DWORD* pdwState)

要素のキャッシュされた Microsoft Active Accessibility の state 識別子を取得します。

pdwStateDWORD*outキャッシュされた要素の状態(MSAA 状態フラグ)を受け取るポインタである。
vtbl 22 HRESULT get_CachedHelp(LPWSTR* pszHelp)

要素のキャッシュされた Microsoft Active Accessibility のヘルプ文字列を取得します。

pszHelpLPWSTR*outキャッシュされた要素のヘルプ文字列を受け取る文字列ポインタへのポインタである。
vtbl 23 HRESULT get_CachedKeyboardShortcut(LPWSTR* pszKeyboardShortcut)

要素のキャッシュされた Microsoft Active Accessibility のキーボードショートカットプロパティを取得します。

pszKeyboardShortcutLPWSTR*outキャッシュされた要素のキーボードショートカット文字列を受け取る文字列ポインタへのポインタである。
vtbl 24 HRESULT GetCachedSelection(IUIAutomationElementArray** pvarSelectedChildren)

この要素の選択された子を識別する、キャッシュされた Microsoft Active Accessibility プロパティを取得します。

pvarSelectedChildrenIUIAutomationElementArray**out選択された子要素のキャッシュされたコレクションへのポインターを受け取ります。

戻り値

型: HRESULT

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

vtbl 25 HRESULT get_CachedDefaultAction(LPWSTR* pszDefaultAction)

要素の Microsoft Active Accessibility のキャッシュされた既定のアクションを取得します。

pszDefaultActionLPWSTR*outキャッシュされた要素の既定アクション文字列を受け取る文字列ポインタへのポインタである。
vtbl 26 HRESULT GetIAccessible(IAccessible** ppAccessible)

Microsoft UI Automation 要素に対応する IAccessible オブジェクトを取得します。

ppAccessibleIAccessible**outアクセス可能なオブジェクトの IAccessible インターフェイスへのポインターを受け取ります。

戻り値

型: HRESULT

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

解説(Remarks)

UI Automation 要素の基盤となる実装がネイティブの Microsoft Active Accessibility サーバーでない場合、このメソッドは NULL を返します。つまり、元々 OLEACC.dll のプロキシオブジェクトによって、または UIA-to-MSAA ブリッジによってサポートされている要素に対して、クライアントが IAccessible インターフェイスを取得しようとした場合です。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IUIAutomationLegacyIAccessiblePattern "{828055AD-355B-4435-86D5-3B51C14A9B1B}"
#usecom global IUIAutomationLegacyIAccessiblePattern IID_IUIAutomationLegacyIAccessiblePattern "{}"
#comfunc global IUIAutomationLegacyIAccessiblePattern_Select                       3 int
#comfunc global IUIAutomationLegacyIAccessiblePattern_DoDefaultAction              4
#comfunc global IUIAutomationLegacyIAccessiblePattern_SetValue                     5 wstr
#comfunc global IUIAutomationLegacyIAccessiblePattern_get_CurrentChildId           6 var
#comfunc global IUIAutomationLegacyIAccessiblePattern_get_CurrentName              7 var
#comfunc global IUIAutomationLegacyIAccessiblePattern_get_CurrentValue             8 var
#comfunc global IUIAutomationLegacyIAccessiblePattern_get_CurrentDescription       9 var
#comfunc global IUIAutomationLegacyIAccessiblePattern_get_CurrentRole              10 var
#comfunc global IUIAutomationLegacyIAccessiblePattern_get_CurrentState             11 var
#comfunc global IUIAutomationLegacyIAccessiblePattern_get_CurrentHelp              12 var
#comfunc global IUIAutomationLegacyIAccessiblePattern_get_CurrentKeyboardShortcut  13 var
#comfunc global IUIAutomationLegacyIAccessiblePattern_GetCurrentSelection          14 sptr
#comfunc global IUIAutomationLegacyIAccessiblePattern_get_CurrentDefaultAction     15 var
#comfunc global IUIAutomationLegacyIAccessiblePattern_get_CachedChildId            16 var
#comfunc global IUIAutomationLegacyIAccessiblePattern_get_CachedName               17 var
#comfunc global IUIAutomationLegacyIAccessiblePattern_get_CachedValue              18 var
#comfunc global IUIAutomationLegacyIAccessiblePattern_get_CachedDescription        19 var
#comfunc global IUIAutomationLegacyIAccessiblePattern_get_CachedRole               20 var
#comfunc global IUIAutomationLegacyIAccessiblePattern_get_CachedState              21 var
#comfunc global IUIAutomationLegacyIAccessiblePattern_get_CachedHelp               22 var
#comfunc global IUIAutomationLegacyIAccessiblePattern_get_CachedKeyboardShortcut   23 var
#comfunc global IUIAutomationLegacyIAccessiblePattern_GetCachedSelection           24 sptr
#comfunc global IUIAutomationLegacyIAccessiblePattern_get_CachedDefaultAction      25 var
#comfunc global IUIAutomationLegacyIAccessiblePattern_GetIAccessible               26 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。