ITextHost::TxGetCharFormat method

Requests the text host's default character format.

Syntax


HRESULT TxGetCharFormat(
  const CHARFORMAT **ppCF
);

Parameters

ppCF

Type: const CHARFORMAT**

The default character 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 codeDescription
E_NOTIMPL

Not implemented.

 

Remarks

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

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Textserv.h

DLL

Msftedit.dll

See also

ITextHost
Reference
CHARFORMAT
OnTxPropertyBitsChange
Conceptual
Windowless Rich Edit Controls

 

 

Community Additions

ADD
Show:
© 2014 Microsoft