DOCERR: Return Values for EditStreamCallback Are Incorrect

• Microsoft Win32 Application Programming Interface (API) included with: - Microsoft Windows NT version 3.51 - Microsoft Windows 95 - Microsoft Win32s version 1.3

SUMMARY

The Win32 SDK documents the return values for the EditStreamCallback incorrectly when the RichEdit control is streaming text in and out. Currently the documentation states that the return value is dependant on whether the control is reading text in or writing text out.

The correct return value for both reading and writing is zero if the read or write was successful, or a non-zero error code otherwise. The number of bytes read or written should be returned in the *pcb parameter. The EditStreamCallback function is called until *pcb receives a zero value. The return value from the EditStreamCallback is interpreted as an SCODE and zero is a successful SCODE. The error code that is returned by the EditStreamCallback is copied to the EDITSTREAM.dwError field so the caller can get an error status.