Help Center
/
Help Center›AfxNova›CRichEdit Class

CRichEdit.StreamInmethod

Replaces the contents of a rich edit control with a stream of data provided by an application defined–EditStreamCallback callback function.

Windowsmethoddocumented

Syntax

FUNCTION StreamIn (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 read.

Description

Replaces the contents of a rich edit control with a stream of data provided by an application defined EditStreamCallback callback function.

Remarks

When you send an StreamIn message, the rich edit control makes repeated calls to the EditStreamCallback function specified by the pfnCallback member of the EDITSTREAM structure. Each time the callback function is called, it fills a buffer with data to read into the control. This continues until the callback function indicates that the stream-in operation has been completed or an error occurs.

Reference

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