ITextPara::GetLineSpacingRule method (tom.h)

Article
02/22/2024

Retrieves the line-spacing rule for the text range.

Syntax

HRESULT GetLineSpacingRule(
  long *pValue
);

Parameters

pValue

Type: long*

A variable that is one of the following values to indicate the line-spacing rule.

tomLineSpaceSingle

tomLineSpace1pt5

tomLineSpaceDouble

tomLineSpaceAtLeast

tomLineSpaceExactly

tomLineSpaceMultiple

tomLineSpacePercent

Return value

Type: HRESULT

If ITextPara::GetLineSpacingRule 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.

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