docs/latex/wx/datostrm.tex

   1 \section{\class{wxDataOutputStream}}\label{wxdataoutputstream}
   2
   3 This class provides functions that write binary data types in a
   4 portable way. Data can be written in either big-endian or litte-endian
   5 format, little-endian being the default on all architectures.
   6
   7 If you want to write data to text files (or streams) use
   8 \helpref{wxTextOutputStream}{wxtextoutputstream} instead.
   9
  10 The << operator is overloaded and you can use this class like a standard
  11 C++ iostream. See \helpref{wxDataInputStream}{wxdatainputstream} for its
  12 usage and caveats.
  13
  14 See also \helpref{wxDataInputStream}{wxdatainputstream}.
  15
  16 \wxheading{Derived from}
  17
  18 None
  19
  20 \latexignore{\rtfignore{\wxheading{Members}}}
  21
  22 \membersection{wxDataOutputStream::wxDataOutputStream}\label{wxdataoutputstreamconstr}
  23
  24 \func{}{wxDataOutputStream}{\param{wxOutputStream\&}{ stream}}
  25
  26 Constructs a datastream object from an output stream. Only write methods will
  27 be available.
  28
  29 \wxheading{Parameters}
  30
  31 \docparam{stream}{The output stream.}
  32
  33 \membersection{wxDataOutputStream::\destruct{wxDataOutputStream}}
  34
  35 \func{}{\destruct{wxDataOutputStream}}{\void}
  36
  37 Destroys the wxDataOutputStream object.
  38
  39 \membersection{wxDataOutputStream::BigEndianOrdered}
  40
  41 \func{void}{BigEndianOrdered}{\param{bool}{ be\_order}}
  42
  43 If {\it be\_order} is TRUE, all data will be written in big-endian
  44 order, e.g. for reading on a Sparc or from Java-Streams (which
  45 always use big-endian order), otherwise data will be written in
  46 little-endian order.
  47
  48 \membersection{wxDataOutputStream::Write8}
  49
  50 \func{void}{Write8}{{\param wxUint8 }{i8}}
  51
  52 Writes the single byte {\it i8} to the stream.
  53
  54 \membersection{wxDataOutputStream::Write16}
  55
  56 \func{void}{Write16}{{\param wxUint16 }{i16}}
  57
  58 Writes the 16 bit integer {\it i16} to the stream.
  59
  60 \membersection{wxDataOutputStream::Write32}
  61
  62 \func{void}{Write32}{{\param wxUint32 }{i32}}
  63
  64 Writes the 32 bit integer {\it i32} to the stream.
  65
  66 \membersection{wxDataOutputStream::WriteDouble}
  67
  68 \func{void}{WriteDouble}{{\param double }{f}}
  69
  70 Writes the double {\it f} to the stream using the IEEE format.
  71
  72 \membersection{wxDataOutputStream::WriteString}
  73
  74 \func{void}{WriteString}{{\param const wxString\& }{string}}
  75
  76 Writes {\it string} to the stream. Actually, this method writes the size of
  77 the string before writing {\it string} itself.
  78