Share via

TextRange_CompareEndpoints Function

  • Article

Returns a value indicating whether two text ranges have identical endpoints.

Syntax

HRESULT TextRange_CompareEndpoints(      
    HUIATEXTRANGE hobj,
    TextPatternRangeEndpoint endpoint,
    ITextRangeInteropProvider *targetRange,
    TextPatternRangeEndpoint targetEndpoint,
    int *pRetVal
);

Parameters

  • hobj
    [in] A text range object.
  • endpoint
    [in] The start or end point of hobj.
  • targetRange
    [in] The text range that is being compared against.
  • targetEndpoint
    [in] The start or end point of targetRange.
  • pRetVal
    [out] When this method returns, contains a pointer to a value that indicates whether two text ranges have identical endpoints. This parameter is passed uninitialized.

Return Value

Returns S_OK if successful or an error value otherwise.

Remarks

The returned value is <0 if the caller's endpoint occurs earlier in the text than the target endpoint; 0 if the caller's endpoint is at the same location as the target endpoint; and >0 if the caller's endpoint occurs later in the text than the target endpoint.

Function Information

Stock Implementation uiautomationcore.dll
Custom Implementation No
Header uiautomationcoreapi.h
Import library uiautomationcore.lib
Minimum operating systems Windows XP