IAnchor::IsEqual method (textstor.h)

Article
02/22/2024

The IAnchor::IsEqual method evaluates two anchors within a text stream and returns a Boolean value that specifies the equality or inequality of the anchor positions.

Syntax

HRESULT IsEqual(
  [in]  IAnchor *paWith,
  [out] BOOL    *pfEqual
);

Parameters

[in] paWith

Specifies an anchor to compare to the primary anchor. Used to determine the equality of the two anchor positions.

[out] pfEqual

A Boolean value that specifies whether the two anchors are positioned at the same location. If set to TRUE, the two anchors occupy the same location. If set to FALSE, the two anchors do not occupy the same location.

Return value

This method can return one of these values.

Value	Description
S_OK	The method was successful.
E_INVALIDARG	pfEqual is invalid.

Remarks

Anchors are always positioned between characters or regions. When two anchors are between the same characters, being at the same offset within the text stream, and within the same region, IAnchor::IsEqual returns TRUE. Otherwise it returns FALSE.

IAnchor::Compare incorporates the same functionality as IAnchor::IsEqual. However, because IAnchor::IsEqual is more specific, it can have a more efficient implementation on the server.

Requirements

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