ITextHost::TxGetParaFormat method (textserv.h)

Requests the text host's default paragraph format.

Syntax

HRESULT TxGetParaFormat(
  const PARAFORMAT **ppPF
);

Parameters

ppPF

Type: const PARAFORMAT**

The default paragraph format.

Return value

Type: HRESULT

Return S_OK if the method succeeds.

Return the following COM error code if the method fails. For more information on COM error codes, see Error Handling in COM.

Return code Description
E_NOTIMPL
Not implemented.

Remarks

The host object retains ownership of the PARAFORMAT structure that is returned. However, the pointer returned must remain valid until the host notifies the text services object, through OnTxPropertyBitsChange, that the default paragraph format has changed.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header textserv.h
DLL Msftedit.dll

See also

Conceptual

ITextHost

OnTxPropertyBitsChange

PARAFORMAT

Reference

Windowless Rich Edit Controls