wxSplitPath() bugs corrected and it's documented

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

diff --git a/docs/latex/wx/strmbase.tex b/docs/latex/wx/strmbase.tex
index 4ff8ade705eedf3630ef7611a3281ebc10c9e951..b04bcdd83b5eb10d0e6e889f93e30f099b9170d7 100644 (file)
--- a/docs/latex/wx/strmbase.tex
+++ b/docs/latex/wx/strmbase.tex
@@ -7,6 +7,10 @@
 
 None
 
 
 None
 

+\wxheading{Include files}
+
+<wx/stream.h>
+

 \wxheading{See also}
 
 \helpref{wxStreamBuffer}{wxstreambuffer}
 \wxheading{See also}
 
 \helpref{wxStreamBuffer}{wxstreambuffer}


@@ -24,7 +28,7 @@ None
 
 \func{}{wxStreamBase}{\void}
 
 
 \func{}{wxStreamBase}{\void}
 

-Creates a dummy stream object.
+Creates a dummy stream object. It doesn't do anything.

 
 \membersection{wxStreamBase::\destruct{wxStreamBase}}
 
 
 \membersection{wxStreamBase::\destruct{wxStreamBase}}
 


@@ -42,14 +46,22 @@ This function returns the last error.
 \twocolitem{{\bf wxStream_NOERROR}}{No error occured.}
 \twocolitem{{\bf wxStream_EOF}}{An End-Of-File occured.}
 \twocolitem{{\bf wxStream_WRITE_ERR}}{A generic error occured on the last write call.}
 \twocolitem{{\bf wxStream_NOERROR}}{No error occured.}
 \twocolitem{{\bf wxStream_EOF}}{An End-Of-File occured.}
 \twocolitem{{\bf wxStream_WRITE_ERR}}{A generic error occured on the last write call.}

-\twocolitem{\bf wxStream_READ_ERR}{A generic error occured on the last read call.}
+\twocolitem{{\bf wxStream_READ_ERR}}{A generic error occured on the last read call.}

 \end{twocollist}
 
 \membersection{wxStreamBase::StreamSize}
 \constfunc{size_t}{StreamSize}{\void}
 
 This function returns the size of the stream. For example, for a file it is the size of
 \end{twocollist}
 
 \membersection{wxStreamBase::StreamSize}
 \constfunc{size_t}{StreamSize}{\void}
 
 This function returns the size of the stream. For example, for a file it is the size of

-the file). Warning! There are streams which do not have size by definition, such as a socket.
+the file).
+
+\wxheading{Warning}
+
+There are streams which do not have size by definition, such as socket streams.
+In that cases, StreamSize returns an invalid size represented by
+\begin{verbatim}
+~(size_t)0
+\end{verbatim}

 
 \membersection{wxStreamBase::OnSysRead}\label{wxstreambaseonsysread}
 
 
 \membersection{wxStreamBase::OnSysRead}\label{wxstreambaseonsysread}
 


@@ -76,5 +88,5 @@ current position in the stream. See \helpref{wxStreamBuffer::Seek}{wxstreambuffe
 \constfunc{off_t}{OnSysTell}{\void}
 
 Internal function. Is is called when the stream buffer needs to know the
 \constfunc{off_t}{OnSysTell}{\void}
 
 Internal function. Is is called when the stream buffer needs to know the

-current position in the stream.
+real position in the stream.