added null pointer check and assert

[wxWidgets.git] / docs / latex / wx / fileistr.tex

diff --git a/docs/latex/wx/fileistr.tex b/docs/latex/wx/fileistr.tex
index b1b1cfb3e66baaa7e137f0fbe4155af0ceed5f59..7e64110f1888a27ecf1373e5fc21ebdca2e138df 100644 (file)
--- a/docs/latex/wx/fileistr.tex
+++ b/docs/latex/wx/fileistr.tex
@@ -5,22 +5,23 @@ 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.
+Note that \helpref{SeekI()}{wxinputstreamseeki} 
+can seek beyond the end of the stream (file) and will thus not return 
+{\it wxInvalidOffset} for that.
 
 \wxheading{Derived from}
 
-\helpref{wxInputStream}{wxinputstream}
+\helpref{wxInputStream}{wxinputstream}\\
+\helpref{wxStreamBase}{wxstreambase}
 
 \wxheading{Include files}
 
 <wx/wfstream.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{wxBufferedInputStream}{wxbufferedinputstream}, \helpref{wxFileOutputStream}{wxfileoutputstream}, \helpref{wxFFileOutputStream}{wxffileoutputstream}
@@ -30,7 +31,7 @@ will report wxSTREAM\_EOF after trying to read {\it past} the last byte.
 % ----------
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxFileInputStream::wxFileInputStream}
+\membersection{wxFileInputStream::wxFileInputStream}\label{wxfileinputstreamctor}
 
 \func{}{wxFileInputStream}{\param{const wxString\&}{ ifileName}}
 
@@ -44,15 +45,15 @@ Initializes a file stream in read-only mode using the file I/O object {\it file}
 
 Initializes a file stream in read-only mode using the specified file descriptor.
 
-\membersection{wxFileInputStream::\destruct{wxFileInputStream}}
+\membersection{wxFileInputStream::\destruct{wxFileInputStream}}\label{wxfileinputstreamdtor}
 
 \func{}{\destruct{wxFileInputStream}}{\void}
 
 Destructor.
 
-\membersection{wxFileInputStream::Ok}
+\membersection{wxFileInputStream::IsOk}\label{wxfileinputstreamisok}
 
-\constfunc{bool}{Ok}{\void}
+\constfunc{bool}{IsOk}{\void}
 
-Returns TRUE if the stream is initialized and ready.
+Returns true if the stream is initialized and ready.