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 little-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 \func{}{wxDataOutputStream}{\param{wxOutputStream\&}{ stream}, \param{wxMBConv\&}{ conv = wxMBConvUTF8}}
  27
  28 Constructs a datastream object from an output stream. Only write methods will
  29 be available. The second form is only available in Unicode build of wxWindows.
  30
  31 \wxheading{Parameters}
  32
  33 \docparam{stream}{The output stream.}
  34
  35 \docparam{conv}{Charset conversion object object used to encoding Unicode
  36 strings before writing them to the stream
  37 in Unicode mode (see \helpref{wxDataOutputStream::WriteString}{wxdataoutputstreamwritestring}
  38 documentation for detailed description). Note that you must not destroy
  39 {\it conv} before you destroy this wxDataOutputStream instance! It is
  40 recommended to use default value (UTF-8).}
  41
  42 \membersection{wxDataOutputStream::\destruct{wxDataOutputStream}}
  43
  44 \func{}{\destruct{wxDataOutputStream}}{\void}
  45
  46 Destroys the wxDataOutputStream object.
  47
  48 \membersection{wxDataOutputStream::BigEndianOrdered}
  49
  50 \func{void}{BigEndianOrdered}{\param{bool}{ be\_order}}
  51
  52 If {\it be\_order} is TRUE, all data will be written in big-endian
  53 order, e.g. for reading on a Sparc or from Java-Streams (which
  54 always use big-endian order), otherwise data will be written in
  55 little-endian order.
  56
  57 \membersection{wxDataOutputStream::Write8}
  58
  59 \func{void}{Write8}{{\param wxUint8 }{i8}}
  60
  61 Writes the single byte {\it i8} to the stream.
  62
  63 \membersection{wxDataOutputStream::Write16}
  64
  65 \func{void}{Write16}{{\param wxUint16 }{i16}}
  66
  67 Writes the 16 bit integer {\it i16} to the stream.
  68
  69 \membersection{wxDataOutputStream::Write32}
  70
  71 \func{void}{Write32}{{\param wxUint32 }{i32}}
  72
  73 Writes the 32 bit integer {\it i32} to the stream.
  74
  75 \membersection{wxDataOutputStream::WriteDouble}
  76
  77 \func{void}{WriteDouble}{{\param double }{f}}
  78
  79 Writes the double {\it f} to the stream using the IEEE format.
  80
  81 \membersection{wxDataOutputStream::WriteString}\label{wxdataoutputstreamwritestring}
  82
  83 \func{void}{WriteString}{{\param const wxString\&}{string}}
  84
  85
  86 Writes {\it string} to the stream. Actually, this method writes the size of
  87 the string before writing {\it string} itself.
  88
  89 In ANSI build of wxWindows, the string is written to the stream in exactly
  90 same way it is represented in memory. In Unicode build, however, the string
  91 is first converted to multibyte representation with {\it conv} object passed
  92 to stream's constructor (consequently, ANSI application can read data
  93 written by Unicode application, as long as they agree on encoding) and this
  94 representation is written to the stream. UTF-8 is used by default.