]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/outptstr.tex
no changes, just come cleanup and more comments
[wxWidgets.git] / docs / latex / wx / outptstr.tex
index b808b05054d01b2f456cd1460450739722dd3a82..a7776b8aee961de4b8ae92c7da9119883f183b09 100644 (file)
@@ -13,26 +13,43 @@ 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::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}
@@ -42,7 +59,7 @@ Returns the number of bytes written during the last
 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}}
 
@@ -67,7 +84,7 @@ 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}