X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f3845e889c7ccfe03d034a0aa79b4f4d19fbcb06..62d3ee70e51f335188a788372a3e66acbcd0bb63:/docs/latex/wx/datostrm.tex diff --git a/docs/latex/wx/datostrm.tex b/docs/latex/wx/datostrm.tex index 1ae9c15a48..8b5492ee8c 100644 --- a/docs/latex/wx/datostrm.tex +++ b/docs/latex/wx/datostrm.tex @@ -1,7 +1,7 @@ \section{\class{wxDataOutputStream}}\label{wxdataoutputstream} This class provides functions that write binary data types in a -portable way. Data can be written in either big-endian or litte-endian +portable way. Data can be written in either big-endian or little-endian format, little-endian being the default on all architectures. If you want to write data to text files (or streams) use @@ -23,13 +23,22 @@ None \func{}{wxDataOutputStream}{\param{wxOutputStream\&}{ stream}} +\func{}{wxDataOutputStream}{\param{wxOutputStream\&}{ stream}, \param{wxMBConv\&}{ conv = wxMBConvUTF8}} + Constructs a datastream object from an output stream. Only write methods will -be available. +be available. The second form is only available in Unicode build of wxWindows. \wxheading{Parameters} \docparam{stream}{The output stream.} +\docparam{conv}{Charset conversion object object used to encoding Unicode +strings before writing them to the stream +in Unicode mode (see \helpref{wxDataOutputStream::WriteString}{wxdataoutputstreamwritestring} +documentation for detailed description). Note that you must not destroy +{\it conv} before you destroy this wxDataOutputStream instance! It is +recommended to use default value (UTF-8).} + \membersection{wxDataOutputStream::\destruct{wxDataOutputStream}} \func{}{\destruct{wxDataOutputStream}}{\void} @@ -69,10 +78,17 @@ Writes the 32 bit integer {\it i32} to the stream. Writes the double {\it f} to the stream using the IEEE format. -\membersection{wxDataOutputStream::WriteString} +\membersection{wxDataOutputStream::WriteString}\label{wxdataoutputstreamwritestring} -\func{void}{WriteString}{{\param const wxString\& }{string}} +\func{void}{WriteString}{{\param const wxString\&}{string}} Writes {\it string} to the stream. Actually, this method writes the size of the string before writing {\it string} itself. +In ANSI build of wxWindows, the string is written to the stream in exactly +same way it is represented in memory. In Unicode build, however, the string +is first converted to multibyte representation with {\it conv} object passed +to stream's constructor (consequently, ANSI application can read data +written by Unicode application, as long as they agree on encoding) and this +representation is written to the stream. UTF-8 is used by default. +