GetEffects method

ITextFont2::GetEffects method

Gets the character format effects.

Syntax


HRESULT GetEffects(
  [out] long *pValue,
  [out] long *pMask
);

Parameters

pValue [out]

Type: long*

A combination of the following character format values.

tomAllCaps
tomBold
tomDisabled
tomEmboss
tomHidden
tomImprint
tomInlineObjectStart
tomItalic
tomLink
tomLinkProtected
tomMathZone
tomMathZoneDisplay
tomMathZoneNoBuildUp
tomMathZoneOrdinary
tomOutline
tomProtected
tomRevised
tomShadow
tomSmallCaps
tomStrikeout
tomUnderline

If the tomInlineObjectStart flag is set, you might want to call GetInlineObject for more inline object properties.

pMask [out]

Type: long*

The differences in these flags over the range. A value of zero indicates that the properties are the same over the range. For an insertion point, this value is always zero.

Return value

Type: HRESULT

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Tom.h

DLL

Msftedit.dll

See also

ITextFont2
ITextFont2::SetEffects

 

 

Show:
© 2016 Microsoft