Edit

Share via

ITextProvider2::GetCaretRange method (uiautomationcore.h)

  • Article

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

Syntax

HRESULT GetCaretRange(
  [out]         BOOL               *isActive,
  [out, retval] ITextRangeProvider **pRetVal
);

Parameters

[out] isActive

Type: BOOL*

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

[out, retval] pRetVal

Type: ITextRangeProvider**

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 that belongs to the text-based control, or to find the text near the caret.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps | UWP apps]
Minimum supported server Windows Server 2012 [desktop apps | UWP apps]
Target Platform Windows
Header uiautomationcore.h (include UIAutomation.h)

See also

ITextProvider2