Minor correction.

[wxWidgets.git] / docs / latex / wx / datistrm.tex

diff --git a/docs/latex/wx/datistrm.tex b/docs/latex/wx/datistrm.tex
index 9c7b18b4b0f3636df43f862f0c5721a3c847417d..4c30437f7011bf5baeb12609dbed3b4aed600230 100644 (file)
--- a/docs/latex/wx/datistrm.tex
+++ b/docs/latex/wx/datistrm.tex
@@ -39,14 +39,14 @@ None
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \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
 
 \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. The second form is only available in Unicode build of wxWindows.
+be available. The second form is only available in Unicode build of wxWidgets.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -57,45 +57,76 @@ mode (see \helpref{wxDataInputStream::ReadString}{wxdatainputstreamreadstring}
 documentation for detailed description). Note that you must not destroy
 {\it conv} before you destroy this wxDataInputStream instance!}
 
 documentation for detailed description). Note that you must not destroy
 {\it conv} before you destroy this wxDataInputStream instance!}
 

-\membersection{wxDataInputStream::\destruct{wxDataInputStream}}
+\membersection{wxDataInputStream::\destruct{wxDataInputStream}}\label{wxdatainputstreamdtor}

 
 \func{}{\destruct{wxDataInputStream}}{\void}
 
 Destroys the wxDataInputStream object.
 
 
 \func{}{\destruct{wxDataInputStream}}{\void}
 
 Destroys the wxDataInputStream object.
 

-\membersection{wxDataInputStream::BigEndianOrdered}
+\membersection{wxDataInputStream::BigEndianOrdered}\label{wxdatainputstreambigendianordered}

 
 \func{void}{BigEndianOrdered}{\param{bool}{ be\_order}}
 
 
 \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).
   
 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.
 
 
 \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}
 
 
 \func{wxUint16}{Read16}{\void}
 

-Reads a 16 bit integer from the stream.
+Reads a 16 bit unsigned integer from the stream.
+
+\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}
+\membersection{wxDataInputStream::Read32}\label{wxdatainputstreamread32}

 
 \func{wxUint32}{Read32}{\void}
 
 
 \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::Read64}\label{wxdatainputstreamread64}

 
 

-\membersection{wxDataInputStream::ReadDouble}
+\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.
 
 
 \func{double}{ReadDouble}{\void}
 
 Reads a double (IEEE encoded) from the stream.
 

+\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}
 \membersection{wxDataInputStream::ReadString}\label{wxdatainputstreamreadstring}
 
 \func{wxString}{ReadString}{\void}


@@ -104,9 +135,10 @@ 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.
 
 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*)
+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}.
 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}.

+