Método ITextPara::GetKeepTogether (tom.h)

Artigo
03/02/2024

Determina se as quebras de página são permitidas dentro de parágrafos.

Sintaxe

HRESULT GetKeepTogether(
  long *pValue
);

Parâmetros

pValue

Tipo: long*

Uma variável que é um dos valores a seguir.

Valor	Significado
tomTrue	Quebras de página não são permitidas dentro de um parágrafo.
tomFalse	Quebras de página são permitidas dentro de um parágrafo.
tomUndefined	A propriedade é indefinida.

Retornar valor

Tipo: HRESULT

Se ITextPara::GetKeepTogether for bem-sucedido, ele retornará S_OK. Se o método falhar, ele retornará um dos seguintes códigos de erro COM. Para obter mais informações sobre códigos de erro COM, consulte Tratamento de erros em COM.

Código de retorno	Descrição
Valor	Significado
E_INVALIDARG	Argumento inválido.
CO_E_RELEASED	O objeto de formatação de parágrafo é anexado a um intervalo que foi excluído.

Comentários

Essa propriedade corresponde ao efeito PFE_KEEP descrito na estrutura PARAFORMAT2 .

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	tom.h
DLL	Msftedit.dll