954b8ae603
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1698 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
92 lines
2.2 KiB
TeX
92 lines
2.2 KiB
TeX
% -----------------------------------------------------------------------------
|
|
% wxOutputStream
|
|
% -----------------------------------------------------------------------------
|
|
\section{\class{wxOutputStream}}\label{wxoutputstream}
|
|
|
|
\wxheading{Derived from}
|
|
|
|
\helpref{wxStreamBase}{wxstreambase}
|
|
|
|
\wxheading{Include files}
|
|
|
|
<wx/stream.h>
|
|
|
|
\wxheading{See also}
|
|
|
|
\helpref{wxStreamBuffer}{wxstreambuffer}
|
|
|
|
% -----------
|
|
% ctor & dtor
|
|
% -----------
|
|
\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}}
|
|
|
|
\func{}{\destruct{wxOutputStream}}{\void}
|
|
|
|
Destructor.
|
|
|
|
% -----------
|
|
% IO function
|
|
% -----------
|
|
\membersection{wxOutputStream::PutC}
|
|
|
|
\func{void}{PutC}{\param{char}{ c}}
|
|
|
|
Puts the specified character in the output queue and increments the
|
|
stream position.
|
|
|
|
\membersection{wxOutputStream::Write}
|
|
|
|
\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.
|
|
|
|
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}}
|
|
|
|
Reads data from the specified input stream and stores them
|
|
in the current stream. The data is read until an error is raised
|
|
by one of the two streams.
|
|
|
|
% ------------------
|
|
% Position functions
|
|
% ------------------
|
|
\membersection{wxOutputStream::SeekO}
|
|
|
|
\func{off_t}{SeekO}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode}}
|
|
|
|
Changes the stream current position.
|
|
|
|
\membersection{wxOutputStream::TellO}
|
|
|
|
\constfunc{off_t}{TellO}{\void}
|
|
|
|
Returns the current stream position.
|
|
|
|
% ---------------
|
|
% State functions
|
|
% ---------------
|
|
\membersection{wxOutputStream::OutputStreamBuffer}
|
|
|
|
\func{wxStreamBuffer *}{OutputStreamBuffer}{\void}
|
|
|
|
Returns the stream buffer associated with the output stream.
|
|
|
|
\membersection{wxOutputStream::LastWrite}
|
|
|
|
\constfunc{size_t}{LastWrite}{\void}
|
|
|