X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f6106dae23c334c30e5e1f2f0763468f61ecce55..42e88ddb611d43fe79e1d0c17a764b0848322f1d:/docs/latex/wx/datistrm.tex diff --git a/docs/latex/wx/datistrm.tex b/docs/latex/wx/datistrm.tex index afca32b111..ae95da775e 100644 --- a/docs/latex/wx/datistrm.tex +++ b/docs/latex/wx/datistrm.tex @@ -1,7 +1,7 @@ \section{\class{wxDataInputStream}}\label{wxdatainputstream} This class provides functions that read binary data types in a -portable way. Data can be read in either big-endian or litte-endian +portable way. Data can be read in either big-endian or little-endian format, little-endian being the default on all architectures. If you want to read data from text files (or streams) use @@ -39,62 +39,106 @@ None \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxDataInputStream::wxDataInputStream}\label{wxdatainputstreamconstr} +\membersection{wxDataInputStream::wxDataInputStream}\label{wxdatainputstreamctor} \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 wxWidgets. \wxheading{Parameters} \docparam{stream}{The input stream.} -\membersection{wxDataInputStream::\destruct{wxDataInputStream}} +\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}}\label{wxdatainputstreamdtor} \func{}{\destruct{wxDataInputStream}}{\void} Destroys the wxDataInputStream object. -\membersection{wxDataInputStream::BigEndianOrdered} +\membersection{wxDataInputStream::BigEndianOrdered}\label{wxdatainputstreambigendianordered} \func{void}{BigEndianOrdered}{\param{bool}{ be\_order}} -If {\it be\_order} is TRUE, all data will be read in big-endian +If {\it be\_order} is true, all data will be read in big-endian order, such as written by programs on a big endian architecture (e.g. Sparc) or written by Java-Streams (which always use big-endian order). -\membersection{wxDataInputStream::Read8} +\membersection{wxDataInputStream::Read8}\label{wxdatainputstreamread8} \func{wxUint8}{Read8}{\void} Reads a single byte from the stream. -\membersection{wxDataInputStream::Read16} +\func{void}{Read8}{\param{wxUint8 *}{buffer}, \param{size\_t }{size}} + +Reads bytes from the stream in a specified buffer. The amount of +bytes to read is specified by the {\it size} variable. + +\membersection{wxDataInputStream::Read16}\label{wxdatainputstreamread16} \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{void}{Read16}{\param{wxUint16 *}{buffer}, \param{size\_t }{size}} + +Reads 16 bit unsigned integers from the stream in a specified buffer. the +amount of 16 bit unsigned integer to read is specified by the {\it size} variable. + +\membersection{wxDataInputStream::Read32}\label{wxdatainputstreamread32} \func{wxUint32}{Read32}{\void} -Reads a 32 bit integer from the stream. +Reads a 32 bit unsigned integer from the stream. + +\func{void}{Read32}{\param{wxUint32 *}{buffer}, \param{size\_t }{size}} + +Reads 32 bit unsigned integers from the stream in a specified buffer. the amount of +32 bit unsigned integer to read is specified by the {\it size} variable. -\membersection{wxDataInputStream::ReadDouble} +\membersection{wxDataInputStream::Read64}\label{wxdatainputstreamread32} + +\func{wxUint64}{Read64}{\void} + +Reads a 64 bit unsigned integer from the stream. + +\func{void}{Read64}{\param{wxUint64 *}{buffer}, \param{size\_t }{size}} + +Reads 64 bit unsigned integers from the stream in a specified buffer. the amount of +64 bit unsigned integer to read is specified by the {\it size} variable. + +\membersection{wxDataInputStream::ReadDouble}\label{wxdatainputstreamreaddouble} \func{double}{ReadDouble}{\void} Reads a double (IEEE encoded) from the stream. -\membersection{wxDataInputStream::ReadString} +\func{void}{ReadDouble}{\param{double *}{buffer}, \param{size\_t }{size}} + +Reads double data (IEEE encoded) from the stream in a specified buffer. the amount of +double to read is specified by the {\it size} variable. + +\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 wxWidgets, 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}.