ITextFont::GetUnderline method

Gets the type of underlining for the characters in a range.

Syntax


HRESULT GetUnderline(
  long *pValue
);

Parameters

pValue

Type: long*

The type of underlining. It can be one of the following values.

tomNone
tomSingle
tomWords
tomDouble
tomDotted
tomDash
tomDashDot
tomDashDotDot
tomWave
tomThick
tomHair
tomDoubleWave
tomHeavyWave
tomLongDash
tomThickDash
tomThickDashDot
tomThickDashDotDot
tomThickDotted
tomThickLongDash

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.

 

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
SetUnderline
Conceptual
Text Object Model

 

 

Community Additions

ADD
Show:
© 2014 Microsoft