IUIAutomation::GetFocusedElement method (uiautomationclient.h)

Article
02/22/2024

Retrieves the UI Automation element that has the input focus.

Syntax

HRESULT GetFocusedElement(
  [out, retval] IUIAutomationElement **element
);

Parameters

[out, retval] element

Type: IUIAutomationElement**

Receives a pointer to the UI Automation element.

Return value

Type: HRESULT

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

Remarks

The IUIAutomation::GetFocusedElement method returns the UIA_E_ELEMENTNOTAVAILABLE error code if the focused element is already removed by the time the method returns. Clients should handle errors from this method gracefully; for example, by trying the call again.

Requirements

Requirement	Value
Minimum supported client	Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista, Windows XP with SP3 and Platform Update for Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008, Windows Server 2003 with SP2 and Platform Update for Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	uiautomationclient.h (include UIAutomation.h)

Share via