ITextFont::GetShadow method

Gets whether characters are displayed as shadowed characters.

Syntax


HRESULT GetShadow(
  long *pValue
);

Parameters

pValue

Type: long*

A tomBool value that can be one of the following.

ValueMeaning
tomTrueCharacters are displayed as shadowed characters.
tomFalseCharacters are not displayed as shadowed characters.
tomUndefinedThe Shadow 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 codeDescription
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_SHADOW effect described in the CHARFORMAT2 structure.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Tom.h

DLL

Msftedit.dll

See also

Reference
ITextFont
SetShadow
CHARFORMAT2
Conceptual
Text Object Model

 

 

Community Additions

ADD
Show:
© 2014 Microsoft