made the alphabetic class order more alphabetic
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@13568 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
100
docs/latex/wx/datistrm.tex
Normal file
100
docs/latex/wx/datistrm.tex
Normal file
@@ -0,0 +1,100 @@
|
||||
\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
|
||||
format, little-endian being the default on all architectures.
|
||||
|
||||
If you want to read data from text files (or streams) use
|
||||
\helpref{wxTextInputStream}{wxtextinputstream} instead.
|
||||
|
||||
The >> operator is overloaded and you can use this class like a standard C++ iostream.
|
||||
Note, however, that the arguments are the fixed size types wxUint32, wxInt32 etc
|
||||
and on a typical 32-bit computer, none of these match to the "long" type (wxInt32
|
||||
is defined as signed int on 32-bit architectures) so that you cannot use long. To avoid
|
||||
problems (here and elsewhere), make use of the wxInt32, wxUint32, etc types.
|
||||
|
||||
For example:
|
||||
|
||||
\begin{verbatim}
|
||||
wxFileInputStream input( "mytext.dat" );
|
||||
wxDataInputStream store( input );
|
||||
wxUint8 i1;
|
||||
float f2;
|
||||
wxString line;
|
||||
|
||||
store >> i1; // read a 8 bit integer.
|
||||
store >> i1 >> f2; // read a 8 bit integer followed by float.
|
||||
store >> line; // read a text line
|
||||
\end{verbatim}
|
||||
|
||||
See also \helpref{wxDataOutputStream}{wxdataoutputstream}.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
None
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/datstrm.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxDataInputStream::wxDataInputStream}\label{wxdatainputstreamconstr}
|
||||
|
||||
\func{}{wxDataInputStream}{\param{wxInputStream\&}{ stream}}
|
||||
|
||||
Constructs a datastream object from an input stream. Only read methods will
|
||||
be available.
|
||||
|
||||
\wxheading{Parameters}
|
||||
|
||||
\docparam{stream}{The input stream.}
|
||||
|
||||
\membersection{wxDataInputStream::\destruct{wxDataInputStream}}
|
||||
|
||||
\func{}{\destruct{wxDataInputStream}}{\void}
|
||||
|
||||
Destroys the wxDataInputStream object.
|
||||
|
||||
\membersection{wxDataInputStream::BigEndianOrdered}
|
||||
|
||||
\func{void}{BigEndianOrdered}{\param{bool}{ be\_order}}
|
||||
|
||||
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}
|
||||
|
||||
\func{wxUint8}{Read8}{\void}
|
||||
|
||||
Reads a single byte from the stream.
|
||||
|
||||
\membersection{wxDataInputStream::Read16}
|
||||
|
||||
\func{wxUint16}{Read16}{\void}
|
||||
|
||||
Reads a 16 bit integer from the stream.
|
||||
|
||||
\membersection{wxDataInputStream::Read32}
|
||||
|
||||
\func{wxUint32}{Read32}{\void}
|
||||
|
||||
Reads a 32 bit integer from the stream.
|
||||
|
||||
\membersection{wxDataInputStream::ReadDouble}
|
||||
|
||||
\func{double}{ReadDouble}{\void}
|
||||
|
||||
Reads a double (IEEE encoded) from the stream.
|
||||
|
||||
\membersection{wxDataInputStream::ReadString}
|
||||
|
||||
\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.
|
||||
|
||||
|
Reference in New Issue
Block a user