ITextPara::GetKeepTogether-Methode (tom.h)

Artikel
03/04/2024

Bestimmt, ob Seitenumbrüche innerhalb von Absätzen zulässig sind.

Syntax

HRESULT GetKeepTogether(
  long *pValue
);

Parameter

pValue

Typ: long*

Eine Variable, die einer der folgenden Werte ist.

Wert	Bedeutung
tomTrue	Seitenumbrüche sind innerhalb eines Absatzes nicht zulässig.
tomFalse	Seitenumbrüche sind innerhalb eines Absatzes zulässig.
tomUndefined	Die Eigenschaft ist nicht definiert.

Rückgabewert

Typ: HRESULT

Wenn ITextPara::GetKeepTogether erfolgreich ist, wird S_OK zurückgegeben. Wenn die Methode fehlschlägt, gibt sie einen der folgenden COM-Fehlercodes zurück. Weitere Informationen zu COM-Fehlercodes finden Sie unter Fehlerbehandlung in COM.

Rückgabecode	Beschreibung
Wert	Bedeutung
E_INVALIDARG	Ungültiges Argument.
CO_E_RELEASED	Das Absatzformatierungsobjekt wird einem gelöschten Bereich angefügt.

Hinweise

Diese Eigenschaft entspricht dem in der PARAFORMAT2-Struktur beschriebenen PFE_KEEP Effekt.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	tom.h
DLL	Msftedit.dll