Share via


EM_STREAMIN

4/8/2010

The EM_STREAMIN message replaces the contents of a RichInk control with a stream of data provided by an application-defined EditStreamCallback callback function.

Syntax

EM_STREAMIN
  wParam = (WPARAM) (UINT) uFormat;
  lParam = (LPARAM) (EDITSTREAM FAR *) lpStream;

Parameters

  • uFormat
    A set of bit flags that indicate the data format and replacement options.

    This value must specify one of the following data formats.

    Flag Data format

    SF_TEXT

    ASCII Text

    SF_RTF

    Rich Text Format (RTF)

    SF_UTEXT

    Unicode text

    SF_PWI

    Word Mobile (formerly Pocket Word) Ink (PWI)

  • lpStream
    Pointer 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.

    When this DLL is used on the desktop, it is assumed that the EDITSTREAM structure contains a dwCookie of the following type:

      pstm;
      bValue;
      pData;
      bLoss;
    

    Note

    Prior to Windows Mobile 6.5, the EDITSTREAM structure's first item was a DWORD, not a DWORD_PTR.

    The RichInk control may then modify the value to indicate whether any data loss occurs during the input conversion. For more information about this structure, see COOKIE.

Return Value

Returns zero if there are no errors.

Remarks

#define EM_STREAMIN (WM_USER + 73)

When you send an EM_STREAMIN message, the RichInk 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.

The EditStreamCallback function returns the number of bytes processed. If this is not the same as the number of bytes requested, then the caller assumes an end-of-file condition has occurred.

Requirements

Header richink.h
Library richink.lib
Windows Embedded CE Windows CE 3.0 and later
Windows Mobile Pocket PC 2000 and later

See Also

Concepts

RichInk Control Messages