ITextPara::GetHyphenation method (tom.h)

  • Article

Determines whether automatic hyphenation is enabled for the range.

Syntax

HRESULT GetHyphenation(
  long *pValue
);

Parameters

pValue

Type: long*

A variable that is one of the following values:

Value Meaning
tomTrue
 Automatic hyphenation is enabled.
tomFalse
 Automatic hyphenation is disabled.
tomUndefined
 The hyphenation property is undefined.

Return value

Type: HRESULT

If ITextPara::GetHyphenation 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
Value
 Meaning
E_INVALIDARG
 Invalid argument.
CO_E_RELEASED
 The paragraph formatting object is attached to a range that has been deleted.

Remarks

This property corresponds to the PFE_DONOTHYPHEN effect described in the PARAFORMAT2 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

See also

Conceptual

ITextPara

PARAFORMAT2

Reference

SetHyphenation

Text Object Model