X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5fec5bb62084ea8241adbc52945d812bf5e659c3..7a9763046b9f7b99399d5538d204b3d8c03bbc2e:/docs/latex/wx/ffilestr.tex diff --git a/docs/latex/wx/ffilestr.tex b/docs/latex/wx/ffilestr.tex index 5970d5c1dd..197c62e7b1 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. @@ -56,9 +49,9 @@ Initializes a file stream in read-only mode using the specified file pointer {\i Destructor. -\membersection{wxFFileInputStream::Ok}\label{wxffileinputstreamok} +\membersection{wxFFileInputStream::IsOk}\label{wxffileinputstreamisok} -\constfunc{bool}{Ok}{\void} +\constfunc{bool}{IsOk}{\void} Returns true if the stream is initialized and ready. @@ -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. @@ -120,9 +106,9 @@ Initializes a file stream in write-only mode using the file descriptor {\it fp}. Destructor. -\membersection{wxFFileOutputStream::Ok}\label{wxffileoutputstreamok} +\membersection{wxFFileOutputStream::IsOk}\label{wxffileoutputstreamisok} -\constfunc{bool}{Ok}{\void} +\constfunc{bool}{IsOk}{\void} Returns true if the stream is initialized and ready.