EM_STREAMOUT

Overview

Group

Quick Info

Windows NT
Yes
Win95
Yes
Win32s
No
Import Library
-
Header File
richedit.h
Unicode
No
Platform Notes
None

The EM_STREAMOUT message writes (streams out) the contents of a rich edit control to the specified data stream.

EM_STREAMOUT

wParam = (WPARAM) (UINT) uFormat;

lParam = (LPARAM) (EDITSTREAM FAR *) lpStream;

Parameters
uFormat

Value specifying one of the following data formats:

Value	Meaning
SF_TEXT	Text with spaces in place of OLE objects
SF_RTF	Rich Text Format (RTF)
SF_RTFNOOBJS	RTF with spaces in place of OLE object.
SF_TEXTIZED	Text with a text representation of OLE objects.

The SF_RTFNOOBJS option is useful if an application stores OLE objects itself, as RTF representation of OLE objects is not very compact. The control word \objattph followed by a space denotes the object position.

All data formats may be combined with the SFF_SELECTION flag. If the SFF_SELECTION flag is specified, only the contents of the current selection are streamed out. Otherwise, the entire contents of the control are streamed out.

The SF_RTF and SF_RTFNOOBJS formats may be combined with the SFF_PLAINRTF flag. If the SFF_PLAINRTF flag is specified, language-specific RTF keywords are ignored. Only keywords common to all languages are streamed out.

lpStream

Pointer to an EDITSTREAM structure. The control streams out the data by repeatedly calling the function specified by the structure's pfnCallback member.

Return Values
Returns the number of characters written to the data stream.