documented that Write() doesn't always write all the data

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@28352 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/latex/wx/outptstr.tex b/docs/latex/wx/outptstr.tex
index 5ebf899fa5a291c4e0c30fda176b69c8475fc0f1..b808b05054d01b2f456cd1460450739722dd3a82 100644 (file)
--- a/docs/latex/wx/outptstr.tex
+++ b/docs/latex/wx/outptstr.tex
@@ -18,23 +18,29 @@ wxOutputStream is an abstract base class which may not be used directly.
 % -----------
 % 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.
 

+

 \membersection{wxOutputStream::\destruct{wxOutputStream}}
 
 \func{}{\destruct{wxOutputStream}}{\void}
 
 Destructor.
 
 \membersection{wxOutputStream::\destruct{wxOutputStream}}
 
 \func{}{\destruct{wxOutputStream}}{\void}
 
 Destructor.
 

-\membersection{wxOutputStream::LastWrite}
+
+\membersection{wxOutputStream::LastWrite}\label{wxoutputstreamlastwrite}

 
 \constfunc{size\_t}{LastWrite}{\void}
 
 
 \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}
 


@@ -43,6 +49,7 @@ Returns the number of bytes written during the last Write().
 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}\label{wxoutputstreamseeko}
 
 \func{off\_t}{SeekO}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}}
 \membersection{wxOutputStream::SeekO}\label{wxoutputstreamseeko}
 
 \func{off\_t}{SeekO}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}}


@@ -59,18 +66,24 @@ Changes the stream current position.
 
 The new stream position or wxInvalidOffset on error.
 
 
 The new stream position or wxInvalidOffset on error.
 

+

 \membersection{wxOutputStream::TellO}
 
 \constfunc{off\_t}{TellO}{\void}
 
 Returns the current stream position.
 
 \membersection{wxOutputStream::TellO}
 
 \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}}
 
 
 \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.