IUIAutomation2::GetCaretElement method

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps | Metro style apps

Retrieves a UI Automation element that represents the system caret.

Syntax

HRESULT GetCaretElement(
  [out]  IUIAutomationElement **caret
);

Parameters

  • caret [out]
    Type: IUIAutomationElement**

    Receives a pointer to the UI Automation element that represents the system caret.

Return value

Type: HRESULT

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

Remarks

For a description of the Microsoft UI Automation properties and events that the system caret supports, see System Caret.

Requirements

Minimum supported client

Windows 8 Consumer Preview

Minimum supported server

Windows Server 8 Beta

Header

UIAutomationClient.h (include UIAutomation.h)

IDL

UIAutomationClient.idl

DLL

UIAutomationCore.dll

See also

IUIAutomation2

 

 

Build date: 3/7/2012