X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/954b8ae60391d18b87a604e7919c87c0c6ae208b..afbe906abdf9aa69a56571b8b20b095351dd8f34:/docs/latex/wx/strmmem.tex diff --git a/docs/latex/wx/strmmem.tex b/docs/latex/wx/strmmem.tex index f22a4bdaa0..920ad7b36e 100644 --- a/docs/latex/wx/strmmem.tex +++ b/docs/latex/wx/strmmem.tex @@ -13,18 +13,7 @@ \wxheading{See also} -\helpref{wxStreamBuffer}{wxstreamBuffer} - -\wxheading{Remark} - -You can create a similar stream by this way: - -\begin{verbatim} - wxStreamBuffer *sb = new wxStreamBuffer(wxStreamBuffer::read); - wxInputStream *input = new wxInputStream(sb); - - sb->SetBufferIO(data, data\_end); -\end{verbatim} +\helpref{wxStreamBuffer}{wxstreambuffer}, \helpref{wxMemoryOutputStream}{wxmemoutputstream} % ---------- % Members @@ -36,11 +25,12 @@ You can create a similar stream by this way: \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}} -\func{}{\destruct{wxFileInputStream}}{\void} +\func{}{\destruct{wxMemoryInputStream}}{\void} Destructor. @@ -59,34 +49,7 @@ Destructor. \wxheading{See also} -\helpref{wxStreamBuffer}{wxstreamBuffer} - -\wxheading{Remark} - -You can create a similar stream by this way: - -\begin{verbatim} - wxStreamBuffer *sb = new wxStreamBuffer(wxStreamBuffer::write); - wxOutputStream *input = new wxOutputStream(sb); - - // If there are data - sb->SetBufferIO(data, data\_end); - // Else - sb->Fixed(FALSE); -\end{verbatim} - -This way is also useful to create read/write memory stream: - -\begin{verbatim} - wxStreamBuffer *sb = new wxStreamBuffer(wxStreamBuffer::read\_write); - wxOutputStream *output = new wxOutputStream(sb); - wxInputStream *input = new wxInputStream(sb); - - // If there are data - sb->SetBufferIO(data, data\_end); - // Else - sb->Fixed(FALSE); -\end{verbatim} +\helpref{wxStreamBuffer}{wxstreambuffer} % ---------- % Members @@ -97,8 +60,8 @@ This way is also useful to create read/write memory stream: \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} @@ -111,3 +74,16 @@ stream. Destructor. +\membersection{wxMemoryOutputStream::CopyTo} + +\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 +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. +