ITfRange::IsEqualStart method
The ITfRange::IsEqualStart method verifies that the start anchor of this range of text matches an anchor of another specified range.
Syntax
HRESULT IsEqualStart( [in] TfEditCookie ec, [in] ITfRange *pWith, [in] TfAnchor aPos, [out] BOOL *pfEqual );
Parameters
- ec [in]
-
Edit cookie obtained from ITfDocumentMgr::CreateContext or ITfEditSession::DoEditSession.
- pWith [in]
-
Pointer to a specified range in which an anchor is to be compared to this range start anchor.
- aPos [in]
-
Enumeration element that indicates which anchor of the specified pWith range to compare to this range start anchor.
Value Meaning - TF_ANCHOR_START
Compares this range start anchor with the specified range start anchor.
- TF_ANCHOR_END
Compares this range start anchor with the specified range end anchor.
- pfEqual [out]
-
Pointer to a Boolean value. Upon return, TRUE indicates that the specified pWith range anchor matches this range start anchor. FALSE indicates otherwise.
Return value
This method can return one of these values.
| Value | Description |
|---|---|
|
The method was successful. |
|
An unspecified error occurred. |
|
One or more parameters are invalid. |
|
The value of the ec parameter is an invalid cookie, or the caller does not have a read-only lock. |
Remarks
This method is identical to, but more efficient than, ITfRange::CompareStart.
Requirements
|
Minimum supported client |
Windows 2000 Professional [desktop apps | Windows Store apps] |
|---|---|
|
Minimum supported server |
Windows 2000 Server [desktop apps | Windows Store apps] |
|
Redistributable |
TSF 1.0 on Windows 2000 Professional |
|
Header |
|
|
IDL |
|
|
DLL |
|
See also
- ITfRange
- Text Stores
- ITfDocumentMgr::CreateContext
- ITfEditSession::DoEditSession
- ITfRange::CompareStart
- ITfRange:IsEqualEnd
- TfAnchor