ITfRange::IsEqualStart method (msctf.h)

Article
02/22/2024

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

[in] ec

Edit cookie obtained from ITfDocumentMgr::CreateContext or ITfEditSession::DoEditSession.

[in] pWith

Pointer to a specified range in which an anchor is to be compared to this range start anchor.

[in] aPos

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.

[out] pfEqual

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
S_OK	The method was successful.
E_FAIL	An unspecified error occurred.
E_INVALIDARG	One or more parameters are invalid.
TF_E_NOLOCK	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

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps \| UWP apps]
Minimum supported server	Windows 2000 Server [desktop apps \| UWP apps]
Target Platform	Windows
Header	msctf.h
DLL	Msctf.dll
Redistributable	TSF 1.0 on Windows 2000 Professional