ITextPara::GetKeepWithNext method (tom.h)

Article
02/22/2024

Determines whether page breaks are allowed between paragraphs in the range.

Syntax

HRESULT GetKeepWithNext(
  long *pValue
);

Parameters

pValue

Type: long*

A variable that is one of the following values:

Value	Meaning
tomTrue	Page breaks are not allowed between paragraphs.
tomFalse	Page breaks are allowed between paragraphs.
tomUndefined	The property is undefined.

Return value

Type: HRESULT

If ITextPara::GetKeepWithNext 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_KEEPNEXT 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