[wxWidgets.git] / docs / latex / wx / strmmem.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}, \helpref{wxMemoryOutputStream}{wxmemoutputstream}

% ----------
% Members
% ----------
\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxMemoryInputStream::wxMemoryInputStream}\label{wxmemoryinputstreamctor}

\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}. The stream does not take ownership of the 
buffer, i.e. that it will not delete in its destructor.

\membersection{wxMemoryInputStream::\destruct{wxMemoryInputStream}}\label{wxmemoryinputstreamdtor}

\func{}{\destruct{wxMemoryInputStream}}{\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}\label{wxmemoryoutputstreamctor}

\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 if required.

\wxheading{Warning}

If the buffer is created, it will be destroyed at the destruction of the
stream.

\membersection{wxMemoryOutputStream::\destruct{wxMemoryOutputStream}}\label{wxmemoryoutputstreamdtor}

\func{}{\destruct{wxMemoryOutputStream}}{\void}

Destructor.

\membersection{wxMemoryOutputStream::CopyTo}\label{wxmemoryoutputstreamcopyto}

\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.
Commit	Line	Data
b36f57c2 GL	1	% -----------------------------------------------------------------------------
	2	% wxMemoryInputStream
	3	% -----------------------------------------------------------------------------
	4	\section{\class{wxMemoryInputStream}}\label{wxmeminputstream}
	5
	6	\wxheading{Derived from}
	7
	8	\helpref{wxInputStream}{wxinputstream}
	9
954b8ae6 JS	10	\wxheading{Include files}
	11
	12	<wx/mstream.h>
	13
b36f57c2 GL	14	\wxheading{See also}
b36f57c2 GL	15
85ec2f26	16	\helpref{wxStreamBuffer}{wxstreambuffer}, \helpref{wxMemoryOutputStream}{wxmemoutputstream}
b36f57c2	17
b36f57c2 GL	18	% ----------
	19	% Members
	20	% ----------
	21	\latexignore{\rtfignore{\wxheading{Members}}}
	22
dcbd177f	23	\membersection{wxMemoryInputStream::wxMemoryInputStream}\label{wxmemoryinputstreamctor}
b36f57c2 GL	24
	25	\func{}{wxMemoryInputStream}{\param{const char *}{ data}, \param{size\_t}{ len}}
	26
	27	Initializes a new read-only memory stream which will use the specified buffer
2bf8e4eb	28	{\it data} of length {\it len}. The stream does not take ownership of the
85ec2f26	29	buffer, i.e. that it will not delete in its destructor.
b36f57c2	30
dcbd177f	31	\membersection{wxMemoryInputStream::\destruct{wxMemoryInputStream}}\label{wxmemoryinputstreamdtor}
b36f57c2	32
85ec2f26	33	\func{}{\destruct{wxMemoryInputStream}}{\void}
b36f57c2 GL	34
	35	Destructor.
	36
	37	% -----------------------------------------------------------------------------
	38	% wxMemoryOutputStream
	39	% -----------------------------------------------------------------------------
	40	\section{\class{wxMemoryOutputStream}}\label{wxmemoutputstream}
	41
	42	\wxheading{Derived from}
	43
	44	\helpref{wxOutputStream}{wxoutputstream}
	45
954b8ae6 JS	46	\wxheading{Include files}
	47
	48	<wx/mstream.h>
	49
b36f57c2 GL	50	\wxheading{See also}
b36f57c2 GL	51
2bf8e4eb	52	\helpref{wxStreamBuffer}{wxstreambuffer}
b36f57c2	53
b36f57c2 GL	54	% ----------
	55	% Members
	56	% ----------
	57	\latexignore{\rtfignore{\wxheading{Members}}}
	58
dcbd177f	59	\membersection{wxMemoryOutputStream::wxMemoryOutputStream}\label{wxmemoryoutputstreamctor}
b36f57c2 GL	60
	61	\func{}{wxMemoryOutputStream}{\param{char *}{ data = NULL}, \param{size\_t}{ length = 0}}
	62
605d715d	63	If {\it data} is NULL, then it will initialize a new empty buffer which will
2bf8e4eb	64	grow if required.
b36f57c2 GL	65
	66	\wxheading{Warning}
	67
	68	If the buffer is created, it will be destroyed at the destruction of the
	69	stream.
	70
dcbd177f	71	\membersection{wxMemoryOutputStream::\destruct{wxMemoryOutputStream}}\label{wxmemoryoutputstreamdtor}
b36f57c2 GL	72
	73	\func{}{\destruct{wxMemoryOutputStream}}{\void}
	74
	75	Destructor.
aed0ed3c	76
dcbd177f	77	\membersection{wxMemoryOutputStream::CopyTo}\label{wxmemoryoutputstreamcopyto}
f439844b GL	78
	79	\constfunc{size\_t}{CopyTo}{\param{char *}{buffer}, \param{size\_t }{len}}
	80
	81	CopyTo allowed you to transfer data from the internal buffer of
605d715d	82	wxMemoryOutputStream to an external buffer. {\it len} specifies the size of
f439844b GL	83	the buffer.
	84
	85	\wxheading{Returned value}
	86
	87	CopyTo returns the number of bytes copied to the buffer. Generally it is either
	88	len or the size of the stream buffer.
22d6efa8	89