docs/latex/wx/strmmem.tex

   1 % -----------------------------------------------------------------------------
   2 % wxMemoryInputStream
   3 % -----------------------------------------------------------------------------
   4 \section{\class{wxMemoryInputStream}}\label{wxmeminputstream}
   5
   6 \wxheading{Derived from}
   7
   8 \helpref{wxInputStream}{wxinputstream}
   9
  10 \wxheading{Include files}
  11
  12 <wx/mstream.h>
  13
  14 \wxheading{See also}
  15
  16 \helpref{wxStreamBuffer}{wxstreambuffer}, \helpref{wxMemoryOutputStream}{wxmemoutputstream}
  17
  18 % ----------
  19 % Members
  20 % ----------
  21 \latexignore{\rtfignore{\wxheading{Members}}}
  22
  23 \membersection{wxMemoryInputStream::wxMemoryInputStream}\label{wxmemoryinputstreamctor}
  24
  25 \func{}{wxMemoryInputStream}{\param{const char *}{ data}, \param{size\_t}{ len}}
  26
  27 Initializes a new read-only memory stream which will use the specified buffer
  28 {\it data} of length {\it len}. The stream does not take ownership of the
  29 buffer, i.e. that it will not delete in its destructor.
  30
  31 \membersection{wxMemoryInputStream::\destruct{wxMemoryInputStream}}\label{wxmemoryinputstreamdtor}
  32
  33 \func{}{\destruct{wxMemoryInputStream}}{\void}
  34
  35 Destructor.
  36
  37 % -----------------------------------------------------------------------------
  38 % wxMemoryOutputStream
  39 % -----------------------------------------------------------------------------
  40 \section{\class{wxMemoryOutputStream}}\label{wxmemoutputstream}
  41
  42 \wxheading{Derived from}
  43
  44 \helpref{wxOutputStream}{wxoutputstream}
  45
  46 \wxheading{Include files}
  47
  48 <wx/mstream.h>
  49
  50 \wxheading{See also}
  51
  52 \helpref{wxStreamBuffer}{wxstreambuffer}
  53
  54 % ----------
  55 % Members
  56 % ----------
  57 \latexignore{\rtfignore{\wxheading{Members}}}
  58
  59 \membersection{wxMemoryOutputStream::wxMemoryOutputStream}\label{wxmemoryoutputstreamctor}
  60
  61 \func{}{wxMemoryOutputStream}{\param{char *}{ data = NULL}, \param{size\_t}{ length = 0}}
  62
  63 If {\it data} is NULL, then it will initialize a new empty buffer which will
  64 grow if required.
  65
  66 \wxheading{Warning}
  67
  68 If the buffer is created, it will be destroyed at the destruction of the
  69 stream.
  70
  71 \membersection{wxMemoryOutputStream::\destruct{wxMemoryOutputStream}}\label{wxmemoryoutputstreamdtor}
  72
  73 \func{}{\destruct{wxMemoryOutputStream}}{\void}
  74
  75 Destructor.
  76
  77 \membersection{wxMemoryOutputStream::CopyTo}\label{wxmemoryoutputstreamcopyto}
  78
  79 \constfunc{size\_t}{CopyTo}{\param{char *}{buffer}, \param{size\_t }{len}}
  80
  81 CopyTo allowed you to transfer data from the internal buffer of
  82 wxMemoryOutputStream to an external buffer. {\it len} specifies the size of
  83 the buffer.
  84
  85 \wxheading{Returned value}
  86
  87 CopyTo returns the number of bytes copied to the buffer. Generally it is either
  88 len or the size of the stream buffer.
  89