ITextHost::TxGetParaFormat method
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 |
---|---|
|
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
Minimum supported client |
Windows Vista [desktop apps only] |
---|---|
Minimum supported server |
Windows Server 2003 [desktop apps only] |
Header |
|
DLL |
|
See also
- ITextHost
- Reference
- OnTxPropertyBitsChange
- PARAFORMAT
- Conceptual
- Windowless Rich Edit Controls