From: Michael Wetherell Date: Tue, 29 Nov 2005 14:09:01 +0000 (+0000) Subject: It seems that wxFileInput/OutputStream now report eof after the last byte has X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/bf085665fd6a214feb7c5bba7e5da827dd5e034d It seems that wxFileInput/OutputStream now report eof after the last byte has been read past, so change docs to match. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@36285 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- diff --git a/docs/latex/wx/ffilestr.tex b/docs/latex/wx/ffilestr.tex index 5970d5c1dd..7f80db6131 100644 --- a/docs/latex/wx/ffilestr.tex +++ b/docs/latex/wx/ffilestr.tex @@ -8,14 +8,7 @@ two such groups of classes: this one is based on \helpref{wxFFile}{wxffile} whereas \helpref{wxFileInputStream}{wxfileinputstream} is based in the \helpref{wxFile}{wxfile} class. -Note that \helpref{wxFile}{wxfile} and \helpref{wxFFile}{wxffile} differ -in one aspect, namely when to report that the end of the file has been -reached. This is documented in \helpref{wxFile::Eof}{wxfileeof} and -\helpref{wxFFile::Eof}{wxffileeof} and the behaviour of the stream -classes reflects this difference, i.e. wxFileInputStream will report -wxSTREAM\_EOF after having read the last byte whereas wxFFileInputStream -will report wxSTREAM\_EOF after trying to read {\it past} the last byte. -Related to EOF behavior, note that \helpref{SeekI()}{wxinputstreamseeki} +Note that \helpref{SeekI()}{wxinputstreamseeki} can seek beyond the end of the stream (file) and will thus not return {\it wxInvalidOffset} for that. @@ -72,14 +65,7 @@ two such groups of classes: this one is based on \helpref{wxFFile}{wxffile} whereas \helpref{wxFileInputStream}{wxffileinputstream} is based in the \helpref{wxFile}{wxfile} class. -Note that \helpref{wxFile}{wxfile} and \helpref{wxFFile}{wxffile} differ -in one aspect, namely when to report that the end of the file has been -reached. This is documented in \helpref{wxFile::Eof}{wxfileeof} and -\helpref{wxFFile::Eof}{wxffileeof} and the behaviour of the stream -classes reflects this difference, i.e. wxFileInputStream will report -wxSTREAM\_EOF after having read the last byte whereas wxFFileInputStream -will report wxSTREAM\_EOF after trying to read {\it past} the last byte. -Related to EOF behavior, note that \helpref{SeekO()}{wxoutputstreamseeko} +Note that \helpref{SeekO()}{wxoutputstreamseeko} can seek beyond the end of the stream (file) and will thus not return {\it wxInvalidOffset} for that. diff --git a/docs/latex/wx/fileistr.tex b/docs/latex/wx/fileistr.tex index 746ec668be..01599e8454 100644 --- a/docs/latex/wx/fileistr.tex +++ b/docs/latex/wx/fileistr.tex @@ -5,14 +5,7 @@ two such groups of classes: this one is based on \helpref{wxFile}{wxfile} whereas \helpref{wxFFileInputStream}{wxffileinputstream} is based in the \helpref{wxFFile}{wxffile} class. -Note that \helpref{wxFile}{wxfile} and \helpref{wxFFile}{wxffile} differ -in one aspect, namely when to report that the end of the file has been -reached. This is documented in \helpref{wxFile::Eof}{wxfileeof} and -\helpref{wxFFile::Eof}{wxffileeof} and the behaviour of the stream -classes reflects this difference, i.e. wxFileInputStream will report -wxSTREAM\_EOF after having read the last byte whereas wxFFileInputStream -will report wxSTREAM\_EOF after trying to read {\it past} the last byte. -Related to EOF behavior, note that \helpref{SeekI()}{wxinputstreamseeki} +Note that \helpref{SeekI()}{wxinputstreamseeki} can seek beyond the end of the stream (file) and will thus not return {\it wxInvalidOffset} for that. diff --git a/docs/latex/wx/fileostr.tex b/docs/latex/wx/fileostr.tex index e0d0c0b4e9..21ce65dd75 100644 --- a/docs/latex/wx/fileostr.tex +++ b/docs/latex/wx/fileostr.tex @@ -8,14 +8,7 @@ two such groups of classes: this one is based on \helpref{wxFile}{wxfile} whereas \helpref{wxFFileInputStream}{wxffileinputstream} is based in the \helpref{wxFFile}{wxffile} class. -Note that \helpref{wxFile}{wxfile} and \helpref{wxFFile}{wxffile} differ -in one aspect, namely when to report that the end of the file has been -reached. This is documented in \helpref{wxFile::Eof}{wxfileeof} and -\helpref{wxFFile::Eof}{wxffileeof} and the behaviour of the stream -classes reflects this difference, i.e. wxFileInputStream will report -wxSTREAM\_EOF after having read the last byte whereas wxFFileInputStream -will report wxSTREAM\_EOF after trying to read {\it past} the last byte. -Related to EOF behavior, note that \helpref{SeekO()}{wxoutputstreamseeko} +Note that \helpref{SeekO()}{wxoutputstreamseeko} can seek beyond the end of the stream (file) and will thus not return {\it wxInvalidOffset} for that.