Help Center
/
Help Center›AfxNova›CRichEditCtx Class

CRichEditCtx.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 psf AS LONG, BYREF edst AS EDITSTREAM) AS DWORD

Parameters

NameDescription
psfSpecifies the data format and replacement options. This value must be one of the following values (see table below).
pedstA 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 call the StreamIn methos, 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/CRichEditCtx.inc:3071
  • Documented in Windows/WIndows Controls/RichEdit/CRichEditCtx Class.md
  • Topic: CRichEditCtx Class