ITextPara::GetKeepTogether method (tom.h)
Determines whether page breaks are allowed within paragraphs.
Syntax
HRESULT GetKeepTogether(
long *pValue
);
Parameters
pValue
Type: long*
A variable that is one of the following values.
| Value | Meaning |
|---|---|
|
Page breaks are not allowed within a paragraph. |
|
Page breaks are allowed within a paragraph. |
|
The property is undefined. |
Return value
Type: HRESULT
If ITextPara::GetKeepTogether 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 |
|---|---|
|
Meaning |
|
Invalid argument. |
|
The paragraph formatting object is attached to a range that has been deleted. |
Remarks
This property corresponds to the PFE_KEEP 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
Reference