Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@28352 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2004-07-21 10:45:28 +00:00
parent 42d0aa30b8
commit b68b06e2ff
1 changed files with 18 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/latex/wx/outptstr.tex
View File

@@ -18,23 +18,29 @@ wxOutputStream is an abstract base class which may not be used directly.
% ----------- % -----------
% ctor & dtor % ctor & dtor
% ----------- % -----------
\membersection{wxOutputStream::wxOutputStream} \membersection{wxOutputStream::wxOutputStream}
\func{}{wxOutputStream}{\void} \func{}{wxOutputStream}{\void}
Creates a dummy wxOutputStream object. Creates a dummy wxOutputStream object.
\membersection{wxOutputStream::\destruct{wxOutputStream}} \membersection{wxOutputStream::\destruct{wxOutputStream}}
\func{}{\destruct{wxOutputStream}}{\void} \func{}{\destruct{wxOutputStream}}{\void}
Destructor. 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 Puts the specified character in the output queue and increments the
stream position. stream position.
\membersection{wxOutputStream::SeekO}\label{wxoutputstreamseeko} \membersection{wxOutputStream::SeekO}\label{wxoutputstreamseeko}
\func{off\_t}{SeekO}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}} \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} \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}
\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}. Writes up to the specified amount of bytes using the data of {\it buffer}. Note
{\it WARNING!} The buffer absolutely needs to have at least the specified size. 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 This function returns a reference on the current object, so the user can test
any states of the stream right away. any states of the stream right away.