Applied patch [ 587450 ] Scoped Smart pointers and docs

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

diff --git a/docs/latex/wx/datistrm.tex b/docs/latex/wx/datistrm.tex
index afca32b1117d76cf6ad110c4ed1e8c316ef82d8f..9c7b18b4b0f3636df43f862f0c5721a3c847417d 100644 (file)
--- 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
 \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 
 format, little-endian being the default on all architectures.
 
 If you want to read data from text files (or streams) use 


@@ -43,13 +43,20 @@ None
 
 \func{}{wxDataInputStream}{\param{wxInputStream\&}{ stream}}
 
 
 \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
 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.}
 
 
 \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}
 \membersection{wxDataInputStream::\destruct{wxDataInputStream}}
 
 \func{}{\destruct{wxDataInputStream}}{\void}


@@ -89,12 +96,17 @@ Reads a 32 bit integer from the stream.
 
 Reads a double (IEEE encoded) from the stream.
 
 
 Reads a double (IEEE encoded) from the stream.
 

-\membersection{wxDataInputStream::ReadString}
+\membersection{wxDataInputStream::ReadString}\label{wxdatainputstreamreadstring}

 
 \func{wxString}{ReadString}{\void}
 
 
 \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}.