EDITSTREAM

The EDITSTREAM structure contains information that an application passes to a rich edit control in a EM_STREAMIN or EM_STREAMOUT message. The rich edit control uses the information to transfer a stream of data into or out of the control.

typedef struct _editstream { 
    DWORD dwCookie; 
    DWORD dwError; 
    EDITSTREAMCALLBACK pfnCallback; 
} EDITSTREAM; 
 

Members

dwCookie

Specifies an application-defined value that the rich edit control passes to the EditStreamCallback callback function specified by the pfnCallback member.

dwError

Indicates the results of the stream-in (read) or stream-out (write) operation. A value of zero indicates no error. A nonzero value can be the return value of the EditStreamCallback function or a code indicating that the control encountered an error.

pfnCallback

Pointer to an EditStreamCallback function, which is an application-defined function that the control calls to transfer data. The control calls the callback function repeatedly, transferring a portion of the data with each call.

QuickInfo

  Windows NT: Requires version 3.51 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in richedit.h.

See Also

Rich Edit Controls Overview, Rich Edit Structures, EditStreamCallback, EM_STREAMIN, EM_STREAMOUT