X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2bf8e4ebcc9d52bcee96e69e7013279a4f2efa37..852b6c3ce7baa055da25f5254f6ee2eee0cd79b7:/docs/latex/wx/strmmem.tex diff --git a/docs/latex/wx/strmmem.tex b/docs/latex/wx/strmmem.tex index 02b78ab155..64f28a1e5f 100644 --- a/docs/latex/wx/strmmem.tex +++ b/docs/latex/wx/strmmem.tex @@ -13,27 +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}. The stream does not take ownership of the -buffer, i.e. that it will not delete in its constructor. +buffer, i.e. the buffer will not be deleted in its destructor. + +\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}. -\membersection{wxMemoryInputStream::\destruct{wxMemoryInputStream}} +\membersection{wxMemoryInputStream::\destruct{wxMemoryInputStream}}\label{wxmemoryinputstreamdtor} -\func{}{\destruct{wxFileInputStream}}{\void} +\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 +68,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 +80,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 +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. +