X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/22d6efa851642c6a69174278fc50f712f41e2271..53b6d7a29879a67a54e1f26e77a0697fecacf839:/docs/latex/wx/strmmem.tex diff --git a/docs/latex/wx/strmmem.tex b/docs/latex/wx/strmmem.tex index 3892bf665d..64f28a1e5f 100644 --- a/docs/latex/wx/strmmem.tex +++ b/docs/latex/wx/strmmem.tex @@ -13,26 +13,39 @@ \wxheading{See also} -\helpref{wxStreamBuffer}{wxstreamBuffer} +\helpref{wxStreamBuffer}{wxstreambuffer}, \helpref{wxMemoryOutputStream}{wxmemoutputstream} % ---------- % Members % ---------- \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}. +{\it data} of length {\it len}. The stream does not take ownership of the +buffer, i.e. the buffer will not be deleted in its destructor. -\membersection{wxMemoryInputStream::\destruct{wxMemoryInputStream}} +\func{}{wxMemoryInputStream}{\param{const wxMemoryOutputStream&}{ stream}} -\func{}{\destruct{wxFileInputStream}}{\void} +Creates a new read-only memory stream, initializing it with the +data from the given output stream \arg{stream}. + +\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 % ----------------------------------------------------------------------------- @@ -48,37 +61,37 @@ Destructor. \wxheading{See also} -\helpref{wxStreamBuffer}{wxstreamBuffer} +\helpref{wxStreamBuffer}{wxstreambuffer} % ---------- % Members % ---------- \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 -grow when it needs. +If {\it data} is NULL, then it will initialize a new empty buffer which will +grow if required. \wxheading{Warning} 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} @@ -86,3 +99,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. +