Documented new constructor and overloaded Create methods.

[wxWidgets.git] / docs / latex / wx / strmmem.tex

diff --git a/docs/latex/wx/strmmem.tex b/docs/latex/wx/strmmem.tex
index ebf0bcaf9df8a51333ee1b9d88dffcae643d553b..920ad7b36e3b181bd62181e33374f0fddbcfaee0 100644 (file)
--- a/docs/latex/wx/strmmem.tex
+++ b/docs/latex/wx/strmmem.tex
@@ -7,19 +7,13 @@
 
 \helpref{wxInputStream}{wxinputstream}
 
 
 \helpref{wxInputStream}{wxinputstream}
 

-\wxheading{See also}
-
-\helpref{wxStreamBuffer}{wxstreamBuffer}
+\wxheading{Include files}

 
 

-\wxheading{Remark}
+<wx/mstream.h>

 
 

-You can create a similar stream by this way:
-\begin{verbatim}
-  wxStreamBuffer *sb = new wxStreamBuffer(wxStreamBuffer::read);
-  wxInputStream *input = new wxInputStream(sb);
+\wxheading{See also}

 
 

-  sb->SetBufferIO(data, data\_end);
-\end{verbatim}
+\helpref{wxStreamBuffer}{wxstreambuffer}, \helpref{wxMemoryOutputStream}{wxmemoutputstream}

 
 % ----------
 % Members
 
 % ----------
 % Members


@@ -31,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
 \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}}
 

-\func{}{\destruct{wxFileInputStream}}{\void}
+\func{}{\destruct{wxMemoryInputStream}}{\void}

 
 Destructor.
 
 
 Destructor.
 


@@ -48,35 +43,13 @@ Destructor.
 
 \helpref{wxOutputStream}{wxoutputstream}
 
 
 \helpref{wxOutputStream}{wxoutputstream}
 

-\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);
+\wxheading{Include files}

 
 

-  // If there are data
-    sb->SetBufferIO(data, data\_end);
-  // Else
-    sb->Fixed(FALSE);
-\end{verbatim}
+<wx/mstream.h>

 
 

-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);
+\wxheading{See also}

 
 

-  // If there are data
-    sb->SetBufferIO(data, data\_end);
-  // Else
-    sb->Fixed(FALSE);
-\end{verbatim}
+\helpref{wxStreamBuffer}{wxstreambuffer}

 
 % ----------
 % Members
 
 % ----------
 % Members


@@ -87,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}}
 
 
 \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}
 
 
 \wxheading{Warning}
 


@@ -100,3 +73,17 @@ stream.
 \func{}{\destruct{wxMemoryOutputStream}}{\void}
 
 Destructor.
 \func{}{\destruct{wxMemoryOutputStream}}{\void}
 
 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.
+