EDITSTREAM

4/8/2010

The EDITSTREAM structure contains information that an application passes to a rich edit control in an 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
  The pointer to the user value passed to callback as first parameter.

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

  Note

  Prior to Windows Mobile 6.5, this parameter was a DWORD, not a DWORD_PTR.

• dwError
  Indicates the results of the stream–in (read) or stream–out (write) operation. A value of zero indicates no error.

  A nonzero value may be either 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 invokes the callback function repeatedly, transferring a portion of the data with each call.

Requirements

See Also

Concepts

RichInk Control Structures