_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.

Syntax

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

Members

dwCookie

Type: DWORD_PTR

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

dwError

Type: DWORD

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

Type: EDITSTREAMCALLBACK

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.

Requirements

   
Windows version Windows Vista [desktop apps only] Windows Server 2003 [desktop apps only]
Header richedit.h

See Also

EM_STREAMIN

EM_STREAMOUT

EditStreamCallback

Reference