Skip to main content
IUIAutomationTextPattern2::GetCaretRange method

Retrieves a zero-length text range at the location of the caret that belongs to the text-based control.

Syntax


HRESULT GetCaretRange(
  [out, retval]  BOOL *isActive,
  [out, retval]  IUIAutomationTextRange **ppRange
);

Parameters

isActive [out, retval]

Type: BOOL*

TRUE if the text-based control that contains the caret has keyboard focus, otherwise FALSE.

ppRange [out, retval]

Type: IUIAutomationTextRange**

Receives a text range that represents the current location of the caret that belongs to the text-based control.

Return value

Type: HRESULT

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

Remarks

If the isActive parameter is FALSE, the caret that belongs to the text-based control might not be at the same location as the system caret.

This method retrieves a text range that a client can use to find the bounding rectangle of the caret belonging to the text-based control, or to find the text near the caret.

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

UIAutomationClient.h (include UIAutomation.h)

IDL

UIAutomationClient.idl

See also

IUIAutomationTextPattern2
UI Automation Support for Textual Content
Working with Text-based Controls