git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	1	% -----------------------------------------------------------------------------
	2	% wxMemoryInputStream
	3	% -----------------------------------------------------------------------------
	4	\section{\class{wxMemoryInputStream}}\label{wxmeminputstream}
	5
	6	\wxheading{Derived from}
	7
	8	\helpref{wxInputStream}{wxinputstream}
	9
	10	\wxheading{Include files}
	11
	12	<wx/mstream.h>
	13
	14	\wxheading{See also}
	15
	16	\helpref{wxStreamBuffer}{wxstreambuffer}, \helpref{wxMemoryOutputStream}{wxmemoutputstream}
	17
	18	% ----------
	19	% Members
	20	% ----------
	21	\latexignore{\rtfignore{\wxheading{Members}}}
	22
	23	\membersection{wxMemoryInputStream::wxMemoryInputStream}\label{wxmemoryinputstreamctor}
	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}. The stream does not take ownership of the
	29	buffer, i.e. the buffer will not be deleted in its destructor.
	30
	31	\func{}{wxMemoryInputStream}{\param{const wxMemoryOutputStream&}{ stream}}
	32
	33	Creates a new read-only memory stream, initializing it with the
	34	data from the given output stream \arg{stream}.
	35
	36	\membersection{wxMemoryInputStream::\destruct{wxMemoryInputStream}}\label{wxmemoryinputstreamdtor}
	37
	38	\func{}{\destruct{wxMemoryInputStream}}{\void}
	39
	40	Destructor.
	41
	42	\membersection{wxMemoryInputStream::GetInputStreamBuffer}\label{wxmemoryinputstreamgetistrmbuf}
	43
	44	\constfunc{wxStreamBuffer *}{GetInputStreamBuffer}{\void}
	45
	46	Returns the pointer to the stream object used as an internal buffer
	47	for that stream.
	48
	49	% -----------------------------------------------------------------------------
	50	% wxMemoryOutputStream
	51	% -----------------------------------------------------------------------------
	52	\section{\class{wxMemoryOutputStream}}\label{wxmemoutputstream}
	53
	54	\wxheading{Derived from}
	55
	56	\helpref{wxOutputStream}{wxoutputstream}
	57
	58	\wxheading{Include files}
	59
	60	<wx/mstream.h>
	61
	62	\wxheading{See also}
	63
	64	\helpref{wxStreamBuffer}{wxstreambuffer}
	65
	66	% ----------
	67	% Members
	68	% ----------
	69	\latexignore{\rtfignore{\wxheading{Members}}}
	70
	71	\membersection{wxMemoryOutputStream::wxMemoryOutputStream}\label{wxmemoryoutputstreamctor}
	72
	73	\func{}{wxMemoryOutputStream}{\param{char *}{ data = NULL}, \param{size\_t}{ length = 0}}
	74
	75	If {\it data} is NULL, then it will initialize a new empty buffer which will
	76	grow if required.
	77
	78	\wxheading{Warning}
	79
	80	If the buffer is created, it will be destroyed at the destruction of the
	81	stream.
	82
	83	\membersection{wxMemoryOutputStream::\destruct{wxMemoryOutputStream}}\label{wxmemoryoutputstreamdtor}
	84
	85	\func{}{\destruct{wxMemoryOutputStream}}{\void}
	86
	87	Destructor.
	88
	89	\membersection{wxMemoryOutputStream::CopyTo}\label{wxmemoryoutputstreamcopyto}
	90
	91	\constfunc{size\_t}{CopyTo}{\param{char *}{buffer}, \param{size\_t }{len}}
	92
	93	CopyTo allowed you to transfer data from the internal buffer of
	94	wxMemoryOutputStream to an external buffer. {\it len} specifies the size of
	95	the buffer.
	96
	97	\wxheading{Returned value}
	98
	99	CopyTo returns the number of bytes copied to the buffer. Generally it is either
	100	len or the size of the stream buffer.
	101
	102	\membersection{wxMemoryOutputStream::GetOutputStreamBuffer}\label{wxmemoryoutputstreamgetostrmbuf}
	103
	104	\constfunc{wxStreamBuffer *}{GetOutputStreamBuffer}{\void}
	105
	106	Returns the pointer to the stream object used as an internal buffer
	107	for that stream.
	108