IHTMLTxtRange::compareEndPoints Method
Compares an end point of a TextRange object with an end point of another range.
Syntax
HRESULT compareEndPoints( BSTR how, IHTMLTxtRange *SourceRange, long *ret );
Parameters
- how
- [in] BSTR that specifies one of the following values:
StartToEnd- Compare the start of the TextRange object with the end of the SourceRange parameter.
StartToStart- Compare the start of the TextRange object with the start of the SourceRange parameter.
EndToStart- Compare the end of the TextRange object with the start of the SourceRange parameter.
EndToEnd- Compare the end of the TextRange object with the end of the SourceRange parameter.
- SourceRange
- [in] Pointer to an IHTMLTxtRange interface that specifies the range to compare with the object.
- ret
- [out, retval] Pointer to a long that receives one of the following possible values:
-1- The end point of the object is further to the left than the end point of SourceRange.
0- The end point of the object is at the same location as the end point of SourceRange.
1- The end point of the object is further to the right than the end point of SourceRange.
Return Value
Returns S_OK if successful, or an error value otherwise.
Remarks
A text range has two end points. One end point is located at the beginning of the text range, and the other is located at the end of the text range. An end point also can be characterized as the position between two characters in an HTML document.
There are four possible end points in the following HTML:
<BODY><P><B>abcThe possible end points are:
- Before the letter a.
- Between the letters a and b.
- Between the letters b and c.
- After the letter c.
An end point cannot be established between the body and the p. Such an end point is considered to be located before the letter a.
This method might not be available on non- Microsoft Win32 platforms.
As of Microsoft Internet Explorer 4.0, an end point is relative to text only, not HTML tags.
See Also