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	\func{}{wxMemoryInputStream}{\param{wxInputStream\&}{ stream}, \param{wxFileOffset}{ len = wxInvalidOffset}}
	37
	38	Creates a new read-only memory stream, initializing it with the
	39	data from the given input stream \arg{stream}.
	40
	41	The \arg{len} argument specifies the amount of data to read from
	42	the \arg{stream}. Setting it to {\it wxInvalidOffset} means that
	43	the \arg{stream} is to be read entirely (i.e. till the EOF is reached).
	44
	45
	46	\membersection{wxMemoryInputStream::\destruct{wxMemoryInputStream}}\label{wxmemoryinputstreamdtor}
	47
	48	\func{}{\destruct{wxMemoryInputStream}}{\void}
	49
	50	Destructor.
	51
	52	\membersection{wxMemoryInputStream::GetInputStreamBuffer}\label{wxmemoryinputstreamgetistrmbuf}
	53
	54	\constfunc{wxStreamBuffer *}{GetInputStreamBuffer}{\void}
	55
	56	Returns the pointer to the stream object used as an internal buffer
	57	for that stream.
	58
	59	% -----------------------------------------------------------------------------
	60	% wxMemoryOutputStream
	61	% -----------------------------------------------------------------------------
	62	\section{\class{wxMemoryOutputStream}}\label{wxmemoutputstream}
	63
	64	\wxheading{Derived from}
	65
	66	\helpref{wxOutputStream}{wxoutputstream}
	67
	68	\wxheading{Include files}
	69
	70	<wx/mstream.h>
	71
	72	\wxheading{See also}
	73
	74	\helpref{wxStreamBuffer}{wxstreambuffer}
	75
	76	% ----------
	77	% Members
	78	% ----------
	79	\latexignore{\rtfignore{\wxheading{Members}}}
	80
	81	\membersection{wxMemoryOutputStream::wxMemoryOutputStream}\label{wxmemoryoutputstreamctor}
	82
	83	\func{}{wxMemoryOutputStream}{\param{char *}{ data = NULL}, \param{size\_t}{ length = 0}}
	84
	85	If {\it data} is NULL, then it will initialize a new empty buffer which will
	86	grow if required.
	87
	88	\wxheading{Warning}
	89
	90	If the buffer is created, it will be destroyed at the destruction of the
	91	stream.
	92
	93	\membersection{wxMemoryOutputStream::\destruct{wxMemoryOutputStream}}\label{wxmemoryoutputstreamdtor}
	94
	95	\func{}{\destruct{wxMemoryOutputStream}}{\void}
	96
	97	Destructor.
	98
	99	\membersection{wxMemoryOutputStream::CopyTo}\label{wxmemoryoutputstreamcopyto}
	100
	101	\constfunc{size\_t}{CopyTo}{\param{char *}{buffer}, \param{size\_t }{len}}
	102
	103	CopyTo allowed you to transfer data from the internal buffer of
	104	wxMemoryOutputStream to an external buffer. {\it len} specifies the size of
	105	the buffer.
	106
	107	\wxheading{Returned value}
	108
	109	CopyTo returns the number of bytes copied to the buffer. Generally it is either
	110	len or the size of the stream buffer.
	111
	112	\membersection{wxMemoryOutputStream::GetOutputStreamBuffer}\label{wxmemoryoutputstreamgetostrmbuf}
	113
	114	\constfunc{wxStreamBuffer *}{GetOutputStreamBuffer}{\void}
	115
	116	Returns the pointer to the stream object used as an internal buffer
	117	for that stream.
	118