ITextFont::GetEngrave method (tom.h)

Article
02/22/2024

Gets whether characters are displayed as imprinted characters.

Syntax

HRESULT GetEngrave(
  long *pValue
);

Parameters

pValue

Type: long*

A tomBool value that can be one of the following.

Value	Meaning
tomTrue	Characters are displayed as imprinted characters.
tomFalse	Characters are not displayed as imprinted characters.
tomUndefined	The Engrave property is undefined.

Return value

Type: HRESULT

If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes. For more information about COM error codes, see Error Handling in COM.

Return code	Description
E_INVALIDARG	Invalid argument.
CO_E_RELEASED	The font object is attached to a range that has been deleted.

Remarks

This property corresponds to the CFE_IMPRINT effect described in the CHARFORMAT2 structure.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	tom.h
DLL	Msftedit.dll