ITextFont::GetSmallCaps method

Gets whether characters are in small capital letters.

Syntax


HRESULT GetSmallCaps(
  long *pValue
);

Parameters

pValue

Type: long*

A tomBool value that can be one of the following.

ValueMeaning
tomTrueCharacters are in small capital letters.
tomFalseCharacters are not in small capital letters.
tomUndefinedThe SmallCaps 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_SMALLCAPS effect described in the CHARFORMAT2 structure.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Tom.h

DLL

Msftedit.dll

See also

Reference
ITextFont
SetSmallCaps
CHARFORMAT2
Conceptual
Text Object Model

 

 

Community Additions

ADD
Show:
© 2015 Microsoft