replaced my recent GSocket_SetReuseAddr() addition with GSocket_SetReusable() from...

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

diff --git a/docs/latex/wx/outptstr.tex b/docs/latex/wx/outptstr.tex
index 543c3e4b53a844a0051f4788a391c437cb42614c..b808b05054d01b2f456cd1460450739722dd3a82 100644 (file)
--- a/docs/latex/wx/outptstr.tex
+++ b/docs/latex/wx/outptstr.tex
@@ -3,6 +3,8 @@
 % -----------------------------------------------------------------------------
 \section{\class{wxOutputStream}}\label{wxoutputstream}
 
 % -----------------------------------------------------------------------------
 \section{\class{wxOutputStream}}\label{wxoutputstream}
 

+wxOutputStream is an abstract base class which may not be used directly.
+

 \wxheading{Derived from}
 
 \helpref{wxStreamBase}{wxstreambase}
 \wxheading{Derived from}
 
 \helpref{wxStreamBase}{wxstreambase}


@@ -11,23 +13,18 @@
 
 <wx/stream.h>
 
 
 <wx/stream.h>
 

-\wxheading{See also}
-
-\helpref{wxStreamBuffer}{wxstreambuffer}
+\latexignore{\rtfignore{\wxheading{Members}}}

 
 % -----------
 % ctor & dtor
 % -----------
 
 % -----------
 % ctor & dtor
 % -----------

+

 \membersection{wxOutputStream::wxOutputStream}
 
 \func{}{wxOutputStream}{\void}
 
 Creates a dummy wxOutputStream object.
 
 \membersection{wxOutputStream::wxOutputStream}
 
 \func{}{wxOutputStream}{\void}
 
 Creates a dummy wxOutputStream object.
 

-\func{}{wxOutputStream}{\param{wxStreamBuffer*}{ sbuf}}
-
-Creates an input stream using the specified stream buffer \it{sbuf}. This
-stream buffer can point to another stream.

 
 \membersection{wxOutputStream::\destruct{wxOutputStream}}
 
 
 \membersection{wxOutputStream::\destruct{wxOutputStream}}
 


@@ -35,15 +32,15 @@ stream buffer can point to another stream.
 
 Destructor.
 
 
 Destructor.
 

-\membersection{wxOutputStream::OutputStreamBuffer}

 
 

-\func{wxStreamBuffer *}{OutputStreamBuffer}{\void}
+\membersection{wxOutputStream::LastWrite}\label{wxoutputstreamlastwrite}

 
 

-Returns the stream buffer associated with the output stream.
+\constfunc{size\_t}{LastWrite}{\void}

 
 

-\membersection{wxOutputStream::LastWrite}
+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.

 
 

-\constfunc{size_t}{LastWrite}{\void}

 
 \membersection{wxOutputStream::PutC}
 
 
 \membersection{wxOutputStream::PutC}
 


@@ -52,29 +49,46 @@ Returns the stream buffer associated with the output stream.
 Puts the specified character in the output queue and increments the
 stream position.
 
 Puts the specified character in the output queue and increments the
 stream position.
 

-\membersection{wxOutputStream::SeekO}

 
 

-\func{off_t}{SeekO}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode}}
+\membersection{wxOutputStream::SeekO}\label{wxoutputstreamseeko}
+
+\func{off\_t}{SeekO}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}}

 
 Changes the stream current position.
 
 
 Changes the stream current position.
 

+\wxheading{Parameters}
+
+\docparam{pos}{Offset to seek to.}
+
+\docparam{mode}{One of {\bf wxFromStart}, {\bf wxFromEnd}, {\bf wxFromCurrent}.}
+
+\wxheading{Return value}
+
+The new stream position or wxInvalidOffset on error.
+
+

 \membersection{wxOutputStream::TellO}
 
 \membersection{wxOutputStream::TellO}
 

-\constfunc{off_t}{TellO}{\void}
+\constfunc{off\_t}{TellO}{\void}

 
 Returns the current stream position.
 
 
 Returns the current stream position.
 

-\membersection{wxOutputStream::Write}

 
 

-\func{wxOutputStream\&}{Write}{\param{const void *}{buffer}, \param{size_t}{ size}}
+\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.
 
 
 This function returns a reference on the current object, so the user can test
 any states of the stream right away.
 

-\func{wxOutputStream\&}{Write}{\param{wxInputStream\&}{ stream_in}}
+\func{wxOutputStream\&}{Write}{\param{wxInputStream\&}{ stream\_in}}

 
 Reads data from the specified input stream and stores them 
 in the current stream. The data is read until an error is raised
 
 Reads data from the specified input stream and stores them 
 in the current stream. The data is read until an error is raised