wxWidgets/docs/latex/wx/strmmem.tex
Julian Smart 22d6efa851 Cured some bugs/typos/spacing in docs
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@3296 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
1999-08-05 22:05:15 +00:00

89 lines
2.2 KiB
TeX

% -----------------------------------------------------------------------------
% wxMemoryInputStream
% -----------------------------------------------------------------------------
\section{\class{wxMemoryInputStream}}\label{wxmeminputstream}
\wxheading{Derived from}
\helpref{wxInputStream}{wxinputstream}
\wxheading{Include files}
<wx/mstream.h>
\wxheading{See also}
\helpref{wxStreamBuffer}{wxstreamBuffer}
% ----------
% Members
% ----------
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxMemoryInputStream::wxMemoryInputStream}
\func{}{wxMemoryInputStream}{\param{const char *}{ data}, \param{size\_t}{ len}}
Initializes a new read-only memory stream which will use the specified buffer
\it{data} of length \it{len}.
\membersection{wxMemoryInputStream::\destruct{wxMemoryInputStream}}
\func{}{\destruct{wxFileInputStream}}{\void}
Destructor.
% -----------------------------------------------------------------------------
% wxMemoryOutputStream
% -----------------------------------------------------------------------------
\section{\class{wxMemoryOutputStream}}\label{wxmemoutputstream}
\wxheading{Derived from}
\helpref{wxOutputStream}{wxoutputstream}
\wxheading{Include files}
<wx/mstream.h>
\wxheading{See also}
\helpref{wxStreamBuffer}{wxstreamBuffer}
% ----------
% Members
% ----------
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxMemoryOutputStream::wxMemoryOutputStream}
\func{}{wxMemoryOutputStream}{\param{char *}{ data = NULL}, \param{size\_t}{ length = 0}}
If \it{data} is NULL, then it will initialize a new empty buffer which will
grow when it needs.
\wxheading{Warning}
If the buffer is created, it will be destroyed at the destruction of the
stream.
\membersection{wxMemoryOutputStream::\destruct{wxMemoryOutputStream}}
\func{}{\destruct{wxMemoryOutputStream}}{\void}
Destructor.
\membersection{wxMemoryOutputStream::CopyTo}
\constfunc{size\_t}{CopyTo}{\param{char *}{buffer}, \param{size\_t }{len}}
CopyTo allowed you to transfer data from the internal buffer of
wxMemoryOutputStream to an external buffer. \it{len} specifies the size of
the buffer.
\wxheading{Returned value}
CopyTo returns the number of bytes copied to the buffer. Generally it is either
len or the size of the stream buffer.