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