X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f439844be27aa4ec09dd1d3365ce44653291c2af..0ff2a74d0cc65f081aafcff79bcd3fd14638814f:/docs/latex/wx/strmmem.tex diff --git a/docs/latex/wx/strmmem.tex b/docs/latex/wx/strmmem.tex index 523b4977fb..49dab77982 100644 --- a/docs/latex/wx/strmmem.tex +++ b/docs/latex/wx/strmmem.tex @@ -13,23 +13,24 @@ \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. that it will not delete in its destructor. -\membersection{wxMemoryInputStream::\destruct{wxMemoryInputStream}} +\membersection{wxMemoryInputStream::\destruct{wxMemoryInputStream}}\label{wxmemoryinputstreamdtor} -\func{}{\destruct{wxFileInputStream}}{\void} +\func{}{\destruct{wxMemoryInputStream}}{\void} Destructor. @@ -48,40 +49,41 @@ 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} CopyTo returns the number of bytes copied to the buffer. Generally it is either len or the size of the stream buffer. +