X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2edb0bdef6238c8c246b6978bc14828b7033d931..47610ec22ab01dbc09307a88ab67c1c95f6ee3b1:/docs/latex/wx/datistrm.tex?ds=sidebyside diff --git a/docs/latex/wx/datistrm.tex b/docs/latex/wx/datistrm.tex index 5b08130575..2bff0f65e6 100644 --- a/docs/latex/wx/datistrm.tex +++ b/docs/latex/wx/datistrm.tex @@ -43,13 +43,20 @@ None \func{}{wxDataInputStream}{\param{wxInputStream\&}{ stream}} +\func{}{wxDataInputStream}{\param{wxInputStream\&}{ stream}, \param{wxMBConv\&}{ conv = wxMBConvUTF8}} + Constructs a datastream object from an input stream. Only read methods will -be available. +be available. The second form is only available in Unicode build of wxWindows. \wxheading{Parameters} \docparam{stream}{The input stream.} +\docparam{conv}{Charset conversion object object used to decode strings in Unicode +mode (see \helpref{wxDataInputStream::ReadString}{wxdatainputstreamreadstring} +documentation for detailed description). Note that you must not destroy +{\it conv} before you destroy this wxDataInputStream instance!} + \membersection{wxDataInputStream::\destruct{wxDataInputStream}} \func{}{\destruct{wxDataInputStream}}{\void} @@ -75,13 +82,19 @@ Reads a single byte from the stream. \func{wxUint16}{Read16}{\void} -Reads a 16 bit integer from the stream. +Reads a 16 bit unsigned integer from the stream. \membersection{wxDataInputStream::Read32} \func{wxUint32}{Read32}{\void} -Reads a 32 bit integer from the stream. +Reads a 32 bit unsigned integer from the stream. + +\membersection{wxDataInputStream::Read64} + +\func{wxUint64}{Read64}{\void} + +Reads a 64 bit unsigned integer from the stream. \membersection{wxDataInputStream::ReadDouble} @@ -89,12 +102,18 @@ Reads a 32 bit integer from the stream. Reads a double (IEEE encoded) from the stream. -\membersection{wxDataInputStream::ReadString} +\membersection{wxDataInputStream::ReadString}\label{wxdatainputstreamreadstring} \func{wxString}{ReadString}{\void} -Reads a string from a stream. Actually, this function first reads a long integer -specifying the length of the string (without the last null character) and then -reads the string. +Reads a string from a stream. Actually, this function first reads a long +integer specifying the length of the string (without the last null character) +and then reads the string. + +In Unicode build of wxWindows, the fuction first reads multibyte (char*) +string from the stream and then converts it to Unicode using the {\it conv} +object passed to constructor and returns the result as wxString. You are +responsible for using the same convertor as when writing the stream. +See also \helpref{wxDataOutputStream::WriteString}{wxdataoutputstreamwritestring}.