no changes, just come cleanup and more comments

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

diff --git a/docs/latex/wx/outptstr.tex b/docs/latex/wx/outptstr.tex
index 5ebf899fa5a291c4e0c30fda176b69c8475fc0f1..a7776b8aee961de4b8ae92c7da9119883f183b09 100644 (file)
--- a/docs/latex/wx/outptstr.tex
+++ b/docs/latex/wx/outptstr.tex
@@ -13,36 +13,60 @@ wxOutputStream 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{wxOutputStream::wxOutputStream}
+
+\membersection{wxOutputStream::wxOutputStream}\label{wxoutputstreamctor}
 
 \func{}{wxOutputStream}{\void}
 
 Creates a dummy wxOutputStream object.
 
-\membersection{wxOutputStream::\destruct{wxOutputStream}}
+
+\membersection{wxOutputStream::\destruct{wxOutputStream}}\label{wxoutputstreamdtor}
 
 \func{}{\destruct{wxOutputStream}}{\void}
 
 Destructor.
 
-\membersection{wxOutputStream::LastWrite}
+
+\membersection{wxOutputStream::Close}\label{wxoutputstreamclose}
+
+\func{bool}{Close}{\void}
+
+Closes the stream, returning {\tt false} if an error occurs. The
+stream is closed implicitly in the destructor if Close() is not
+called explicitly.
+
+If this stream wraps another stream or some other resource such
+as a file, then the underlying resource is closed too if it is owned
+by this stream, or left open otherwise.
+
+
+\membersection{wxOutputStream::LastWrite}\label{wxoutputstreamlastwrite}
 
 \constfunc{size\_t}{LastWrite}{\void}
 
-Returns the number of bytes written during the last Write().
+Returns the number of bytes written during the last 
+\helpref{Write()}{wxoutputstreamwrite}. It may return $0$ even if there is no
+error on the stream if it is only temporarily impossible to write to it.
+
 
-\membersection{wxOutputStream::PutC}
+\membersection{wxOutputStream::PutC}\label{wxoutputstreamputc}
 
 \func{void}{PutC}{\param{char}{ c}}
 
 Puts the specified character in the output queue and increments the
 stream position.
 
+
 \membersection{wxOutputStream::SeekO}\label{wxoutputstreamseeko}
 
 \func{off\_t}{SeekO}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}}
@@ -59,18 +83,24 @@ Changes the stream current position.
 
 The new stream position or wxInvalidOffset on error.
 
-\membersection{wxOutputStream::TellO}
+
+\membersection{wxOutputStream::TellO}\label{wxoutputstreamtello}
 
 \constfunc{off\_t}{TellO}{\void}
 
 Returns the current stream position.
 
-\membersection{wxOutputStream::Write}
+
+\membersection{wxOutputStream::Write}\label{wxoutputstreamwrite}
 
 \func{wxOutputStream\&}{Write}{\param{const void *}{buffer}, \param{size\_t}{ size}}
 
-Writes the specified amount of bytes using the data of {\it buffer}. 
-{\it WARNING!} The buffer absolutely needs to have at least the specified size.
+Writes up to the specified amount of bytes using the data of {\it buffer}. Note
+that not all data can always be written so you must check the number of bytes
+really written to the stream using \helpref{LastWrite()}{wxoutputstreamlastwrite} 
+when this function returns. In some cases (for example a write end of a pipe
+which is currently full) it is even possible that there is no errors and zero
+bytes have been written.
 
 This function returns a reference on the current object, so the user can test
 any states of the stream right away.