X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/85ec2f26343b107d32d3821217f47ade57fcadc0..81c882b613b5d99ddb1e5ab69fcd7ebccc287025:/docs/latex/wx/strmmem.tex diff --git a/docs/latex/wx/strmmem.tex b/docs/latex/wx/strmmem.tex index 6310696d91..c2b85338cb 100644 --- a/docs/latex/wx/strmmem.tex +++ b/docs/latex/wx/strmmem.tex @@ -20,20 +20,42 @@ % ---------- \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxMemoryInputStream::wxMemoryInputStream} +\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. +buffer, i.e. the buffer will not be deleted in its destructor. -\membersection{wxMemoryInputStream::\destruct{wxMemoryInputStream}} +\func{}{wxMemoryInputStream}{\param{const wxMemoryOutputStream&}{ stream}} + +Creates a new read-only memory stream, initializing it with the +data from the given output stream \arg{stream}. + +\func{}{wxMemoryInputStream}{\param{wxInputStream\&}{ stream}, \param{wxFileOffset}{ len = wxInvalidOffset}} + +Creates a new read-only memory stream, initializing it with the +data from the given input stream \arg{stream}. + +The \arg{len} argument specifies the amount of data to read from +the \arg{stream}. Setting it to {\it wxInvalidOffset} means that +the \arg{stream} is to be read entirely (i.e. till the EOF is reached). + + +\membersection{wxMemoryInputStream::\destruct{wxMemoryInputStream}}\label{wxmemoryinputstreamdtor} \func{}{\destruct{wxMemoryInputStream}}{\void} Destructor. +\membersection{wxMemoryInputStream::GetInputStreamBuffer}\label{wxmemoryinputstreamgetistrmbuf} + +\constfunc{wxStreamBuffer *}{GetInputStreamBuffer}{\void} + +Returns the pointer to the stream object used as an internal buffer +for that stream. + % ----------------------------------------------------------------------------- % wxMemoryOutputStream % ----------------------------------------------------------------------------- @@ -56,11 +78,11 @@ Destructor. % ---------- \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxMemoryOutputStream::wxMemoryOutputStream} +\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 +If {\it data} is NULL, then it will initialize a new empty buffer which will grow if required. \wxheading{Warning} @@ -68,18 +90,18 @@ grow if required. If the buffer is created, it will be destroyed at the destruction of the stream. -\membersection{wxMemoryOutputStream::\destruct{wxMemoryOutputStream}} +\membersection{wxMemoryOutputStream::\destruct{wxMemoryOutputStream}}\label{wxmemoryoutputstreamdtor} \func{}{\destruct{wxMemoryOutputStream}}{\void} Destructor. -\membersection{wxMemoryOutputStream::CopyTo} +\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 +wxMemoryOutputStream to an external buffer. {\it len} specifies the size of the buffer. \wxheading{Returned value} @@ -87,3 +109,10 @@ the buffer. CopyTo returns the number of bytes copied to the buffer. Generally it is either len or the size of the stream buffer. +\membersection{wxMemoryOutputStream::GetOutputStreamBuffer}\label{wxmemoryoutputstreamgetostrmbuf} + +\constfunc{wxStreamBuffer *}{GetOutputStreamBuffer}{\void} + +Returns the pointer to the stream object used as an internal buffer +for that stream. +