ITextRangeProvider::Compare method (uiautomationcore.h)

Article
02/22/2024

Retrieves a value that specifies whether this text range has the same endpoints as another text range.

Syntax

HRESULT Compare(
  [in]          ITextRangeProvider *range,
  [out, retval] BOOL               *pRetVal
);

Parameters

[in] range

Type: ITextRangeProvider*

The text range to compare with this one.

[out, retval] pRetVal

Type: BOOL*

Receives TRUE if the text ranges have the same endpoints, or FALSE if they do not.

Return value

Type: HRESULT

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

Remarks

This method compares the endpoints of the two text ranges, not the text in the ranges. The ranges are identical if they share the same endpoints. If two text ranges have different endpoints, they are not identical even if the text in both ranges is exactly the same.

Requirements

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