Help Center
/
Help Center›AfxNova›CRichEdit Class

CRichEdit.StreamOutmethod

Causes a rich edit control to pass its contents to an application–defined EditStreamCallback callback function.

Windowsmethoddocumented

Syntax

FUNCTION StreamOut (BYVAL hRichEdit AS HWND, BYVAL psf AS LONG, BYVAL pedst AS EDITSTREAM PTR) AS DWORD

Parameters

NameDescription
hRichEditThe handle of the rich edit control.
psfSpecifies the data format and replacement options. This value must be one of the following values (see table below).
pedstPointer to an EDITSTREAM structure. On input, the pfnCallback member of this structure must point to an application defined EditStreamCallback function. On output, the dwError member can contain a nonzero error code if an error occurred.

Return value

This message returns the number of characters written to the data stream.

Description

Causes a rich edit control to pass its contents to an application defined EditStreamCallback callback function. The callback function can then write the stream of data to a file or any other location that it chooses.

Remarks

When you send an StreamOut message, the rich edit control makes repeated calls to the EditStreamCallback function specified by the pfnCallback member of the EDITSTREAM structure. Each time it calls the callback function, the control passes a buffer containing a portion of the contents of the control. This process continues until the control has passed all its contents to the callback function, or until an error occurs.

Reference

  • Defined in AfxNova/CRichEdit.inc:1337
  • Documented in Windows/WIndows Controls/CRichEdit Class.md
  • Topic: CRichEdit Class