X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/605d715ddd84ddc3e78423e3f3ae5c27c8ff4d43..c36cdfc084f779b67668af8cad3eb6906182af21:/docs/latex/wx/strmmem.tex diff --git a/docs/latex/wx/strmmem.tex b/docs/latex/wx/strmmem.tex index 920ad7b36e..ec70a884fb 100644 --- a/docs/latex/wx/strmmem.tex +++ b/docs/latex/wx/strmmem.tex @@ -5,12 +5,17 @@ \wxheading{Derived from} -\helpref{wxInputStream}{wxinputstream} +\helpref{wxInputStream}{wxinputstream}\\ +\helpref{wxStreamBase}{wxstreambase} \wxheading{Include files} +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{See also} \helpref{wxStreamBuffer}{wxstreambuffer}, \helpref{wxMemoryOutputStream}{wxmemoutputstream} @@ -20,20 +25,42 @@ % ---------- \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 destructor. +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}. + +\func{}{wxMemoryInputStream}{\param{wxInputStream\&}{ stream}, \param{wxFileOffset}{ len = wxInvalidOffset}} + +Creates a new read-only memory stream, initializing it with the +data from the given input stream \arg{stream}. + +The \arg{len} argument specifies the amount of data to read from +the \arg{stream}. Setting it to {\it wxInvalidOffset} means that +the \arg{stream} is to be read entirely (i.e. till the EOF is reached). + -\membersection{wxMemoryInputStream::\destruct{wxMemoryInputStream}} +\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 % ----------------------------------------------------------------------------- @@ -41,12 +68,17 @@ Destructor. \wxheading{Derived from} -\helpref{wxOutputStream}{wxoutputstream} +\helpref{wxOutputStream}{wxoutputstream}\\ +\helpref{wxStreamBase}{wxstreambase} \wxheading{Include files} +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{See also} \helpref{wxStreamBuffer}{wxstreambuffer} @@ -56,7 +88,7 @@ Destructor. % ---------- \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxMemoryOutputStream::wxMemoryOutputStream} +\membersection{wxMemoryOutputStream::wxMemoryOutputStream}\label{wxmemoryoutputstreamctor} \func{}{wxMemoryOutputStream}{\param{char *}{ data = NULL}, \param{size\_t}{ length = 0}} @@ -68,13 +100,13 @@ 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}} @@ -87,3 +119,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. +