[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}

% ----------
% 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.
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}
	15
	16	\helpref{wxStreamBuffer}{wxstreamBuffer}
	17
b36f57c2 GL	18	% ----------
	19	% Members
	20	% ----------
	21	\latexignore{\rtfignore{\wxheading{Members}}}
	22
	23	\membersection{wxMemoryInputStream::wxMemoryInputStream}
	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
	28	\it{data} of length \it{len}.
	29
	30	\membersection{wxMemoryInputStream::\destruct{wxMemoryInputStream}}
	31
	32	\func{}{\destruct{wxFileInputStream}}{\void}
	33
	34	Destructor.
	35
	36	% -----------------------------------------------------------------------------
	37	% wxMemoryOutputStream
	38	% -----------------------------------------------------------------------------
	39	\section{\class{wxMemoryOutputStream}}\label{wxmemoutputstream}
	40
	41	\wxheading{Derived from}
	42
	43	\helpref{wxOutputStream}{wxoutputstream}
	44
954b8ae6 JS	45	\wxheading{Include files}
	46
	47	<wx/mstream.h>
	48
b36f57c2 GL	49	\wxheading{See also}
	50
	51	\helpref{wxStreamBuffer}{wxstreamBuffer}
	52
b36f57c2 GL	53	% ----------
	54	% Members
	55	% ----------
	56	\latexignore{\rtfignore{\wxheading{Members}}}
	57
	58	\membersection{wxMemoryOutputStream::wxMemoryOutputStream}
	59
	60	\func{}{wxMemoryOutputStream}{\param{char *}{ data = NULL}, \param{size\_t}{ length = 0}}
	61
	62	If \it{data} is NULL, then it will initialize a new empty buffer which will
	63	grow when it needs.
	64
	65	\wxheading{Warning}
	66
	67	If the buffer is created, it will be destroyed at the destruction of the
	68	stream.
	69
	70	\membersection{wxMemoryOutputStream::\destruct{wxMemoryOutputStream}}
	71
	72	\func{}{\destruct{wxMemoryOutputStream}}{\void}
	73
	74	Destructor.
aed0ed3c	75
f439844b GL	76	\membersection{wxMemoryOutputStream::CopyTo}
	77
	78	\constfunc{size\_t}{CopyTo}{\param{char *}{buffer}, \param{size\_t }{len}}
	79
	80	CopyTo allowed you to transfer data from the internal buffer of
	81	wxMemoryOutputStream to an external buffer. \it{len} specifies the size of
	82	the buffer.
	83
	84	\wxheading{Returned value}
	85
	86	CopyTo returns the number of bytes copied to the buffer. Generally it is either
	87	len or the size of the stream buffer.
22d6efa8	88