ITextFont::IsEqual method (tom.h)

Determines whether this text font object has the same properties as the specified text font object.

Syntax

HRESULT IsEqual(
  ITextFont *pFont,
  long      *pValue
);

Parameters

pFont

Type: ITextFont*

The text font object to compare against.

pValue

Type: long*

A variable that is tomTrue if the font objects have the same properties or tomFalse if they do not. This parameter can be NULL.

Return value

Type: HRESULT

If the text font objects have the same properties, the method succeeds and returns S_OK. If the text font objects do not have the same properties, the method fails and returns S_FALSE. For more information about COM error codes, see Error Handling in COM.

Remarks

The text font objects are equal only if pFont belongs to the same Text Object Model (TOM) object as the current font object. The ITextFont::IsEqual method ignores entries for which either font object has an tomUndefined.

Requirements

See also

Conceptual

ITextFont

Reference

Text Object Model