UiaIAccessibleFromProvider function (uiautomationcoreapi.h)

Article
2024-02-22

Retrieves an IAccessible implementation that provides Microsoft Active Accessibility data on behalf of a Microsoft UI Automation provider.

Syntax

HRESULT UiaIAccessibleFromProvider(
  [in]  IRawElementProviderSimple *pProvider,
  [in]  DWORD                     dwFlags,
  [out] IAccessible               **ppAccessible,
  [out] VARIANT                   *pvarChild
);

Parameters

[in] pProvider

Type: IRawElementProviderSimple*

A pointer to the UI Automation object.

[in] dwFlags

Type: DWORD

One of the following values:

UIA_IAFP_DEFAULT

UIA_IAFP_UNWRAP_BRIDGE

[out] ppAccessible

Type: IAccessible**

Receives the pointer to the IAccessible implementation for the provider.

[out] pvarChild

Type: VARIANT*

Receives the child identifier of the accessible element in the lVal member.

Return value

Type: HRESULT

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

In most cases, this function retrieves a wrapper object, provided by Windows, that implements IAccessible on behalf of the IRawElementProviderSimple object. If the provided IRawElementProviderSimple pointer is itself a wrapper object, this function retrieves the wrapped IAccessible pointer and returns that instead, to prevent the creation of multiple layers of wrappers.

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Target Platform	Windows
Header	uiautomationcoreapi.h
Library	Uiautomationcore.lib
DLL	Uiautomationcore.dll

Share via