added null pointer check and assert

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

diff --git a/docs/latex/wx/inputstr.tex b/docs/latex/wx/inputstr.tex
index 05f45a1884434f9f6b47000bf30e35a87f0a28d0..8fa169ef5d609b7e54661fd96d7a4e91a0744b4c 100644 (file)
--- a/docs/latex/wx/inputstr.tex
+++ b/docs/latex/wx/inputstr.tex
@@ -13,24 +13,35 @@ wxInputStream is an abstract base class which may not be used directly.
 
 <wx/stream.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 % -----------
 % ctor & dtor
 % -----------
-\membersection{wxInputStream::wxInputStream}
+\membersection{wxInputStream::wxInputStream}\label{wxinputstreamctor}
 
 \func{}{wxInputStream}{\void}
 
 Creates a dummy input stream.
 
-\membersection{wxInputStream::\destruct{wxInputStream}}
+\membersection{wxInputStream::\destruct{wxInputStream}}\label{wxinputstreamdtor}
 
 \func{}{\destruct{wxInputStream}}{\void}
 
 Destructor.
 
-\membersection{wxInputStream::GetC}
+\membersection{wxInputStream::CanRead}\label{wxinputstreamcanread}
+
+\constfunc{bool}{CanRead}{\void}
+
+Returns true if some data is available in the stream right now, so that
+calling \helpref{Read()}{wxinputstreamread} wouldn't block.
+
+\membersection{wxInputStream::GetC}\label{wxinputstreamgetc}
 
 \func{char}{GetC}{\void}
 
@@ -43,14 +54,18 @@ If EOF, return value is undefined and LastRead() will return 0 and not 1.
 
 \membersection{wxInputStream::Eof}\label{wxinputstreameof}
 
-\constfunc{wxInputStream}{Eof}{\void}
+\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}
 
-This cannot be really implemented for all streams and CanRead() is more 
-reliable than Eof().
+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}
 
@@ -58,7 +73,7 @@ reliable than Eof().
 
 Returns the last number of bytes read.
 
-\membersection{wxInputStream::Peek}
+\membersection{wxInputStream::Peek}\label{wxinputstreampeek}
 
 \func{char}{Peek}{\void}
 
@@ -70,7 +85,7 @@ Blocks until something appears in the stream if necessary, if nothing
 ever does (i.e. EOF) LastRead() will return 0 (and the return value is
 undefined), otherwise LastRead() returns 1.
 
-\membersection{wxInputStream::Read}
+\membersection{wxInputStream::Read}\label{wxinputstreamread}
 
 \func{wxInputStream\&}{Read}{\param{void *}{buffer}, \param{size\_t}{ size}}
 
@@ -111,7 +126,7 @@ Changes the stream current position.
 
 The new stream position or wxInvalidOffset on error.
 
-\membersection{wxInputStream::TellI}
+\membersection{wxInputStream::TellI}\label{wxinputstreamtelli}
 
 \constfunc{off\_t}{TellI}{\void}