Make behaviour of Eof() more consistent

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@36299 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Michael Wetherell 2005-11-30 13:14:00 +00:00
parent 8e50d1add6
commit 7ab86a6a27

View File

@ -52,15 +52,16 @@ If EOF, return value is undefined and LastRead() will return 0 and not 1.
\constfunc{bool}{Eof}{\void}
Returns true if the end of stream has been reached.
Returns true after an attempt has been made to read past the end of the
stream.
\wxheading{Note}
For some streams Eof() will not return true until an
attempt has been made to read past the end of the stream.
\helpref{LastRead()}{wxinputstreamlastread}
should be called after each read to check that
a non-zero number of bytes have been read.
In wxWidgets 2.6.x and below some streams returned Eof() when the last
byte had been read rather than when an attempt had been made to read
past the last byte. If you want to avoid depending on one behaviour or
the other then call \helpref{LastRead()}{wxinputstreamlastread} to
check the number of bytes actually read.
\membersection{wxInputStream::LastRead}\label{wxinputstreamlastread}