X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fc1f28995deec01b48581e2eb1070c1c5a4ad6ab..3cc305b2b4a0674c56c84d7088cfd70676b850f0:/docs/latex/wx/inputstr.tex diff --git a/docs/latex/wx/inputstr.tex b/docs/latex/wx/inputstr.tex index 7f48f40df4..8fa169ef5d 100644 --- a/docs/latex/wx/inputstr.tex +++ b/docs/latex/wx/inputstr.tex @@ -13,6 +13,10 @@ wxInputStream is an abstract base class which may not be used directly. +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \latexignore{\rtfignore{\wxheading{Members}}} % ----------- @@ -52,15 +56,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}