X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/22d6efa851642c6a69174278fc50f712f41e2271..d9ff0f91fbddae88286567cab74dcfb59c91fc0f:/docs/latex/wx/datstrm.tex?ds=sidebyside diff --git a/docs/latex/wx/datstrm.tex b/docs/latex/wx/datstrm.tex index c8da9fd39e..7eaabb563d 100644 --- a/docs/latex/wx/datstrm.tex +++ b/docs/latex/wx/datstrm.tex @@ -17,6 +17,7 @@ is defined as signed int on 32-bit architectures) so that you cannot use long. T problems (here and elsewhere), make use of the wxInt32, wxUint32, etc types. For example: + \begin{verbatim} wxFileInputStream input( "mytext.dat" ); wxDataInputStream store( input ); @@ -31,6 +32,10 @@ For example: See also \helpref{wxDataOutputStream}{wxdataoutputstream}. +\wxheading{Derived from} + +None + \wxheading{Include files} @@ -56,9 +61,9 @@ Destroys the wxDataInputStream object. \membersection{wxDataInputStream::BigEndianOrdered} -\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). @@ -89,7 +94,7 @@ Reads a double (IEEE encoded) from the stream. \membersection{wxDataInputStream::ReadString} -\func{wxString}{wxDataInputStream::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 @@ -114,6 +119,10 @@ usage and caveats. See also \helpref{wxDataInputStream}{wxdatainputstream}. +\wxheading{Derived from} + +None + \latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxDataOutputStream::wxDataOutputStream}\label{wxdataoutputstreamconstr} @@ -135,40 +144,40 @@ Destroys the wxDataOutputStream object. \membersection{wxDataOutputStream::BigEndianOrdered} -\func{void}{BigEndianOrdered}{\param{bool}{ be_order}} +\func{void}{BigEndianOrdered}{\param{bool}{ be\_order}} -If {\it be_order} is TRUE, all data will be written in big-endian +If {\it be\_order} is TRUE, all data will be written in big-endian order, e.g. for reading on a Sparc or from Java-Streams (which always use big-endian order), otherwise data will be written in little-endian order. \membersection{wxDataOutputStream::Write8} -\func{void}{wxDataOutputStream::Write8}{{\param wxUint8 }{i8}} +\func{void}{Write8}{{\param wxUint8 }{i8}} Writes the single byte {\it i8} to the stream. \membersection{wxDataOutputStream::Write16} -\func{void}{wxDataOutputStream::Write16}{{\param wxUint16 }{i16}} +\func{void}{Write16}{{\param wxUint16 }{i16}} Writes the 16 bit integer {\it i16} to the stream. \membersection{wxDataOutputStream::Write32} -\func{void}{wxDataOutputStream::Write32}{{\param wxUint32 }{i32}} +\func{void}{Write32}{{\param wxUint32 }{i32}} Writes the 32 bit integer {\it i32} to the stream. \membersection{wxDataOutputStream::WriteDouble} -\func{void}{wxDataOutputStream::WriteDouble}{{\param double }{f}} +\func{void}{WriteDouble}{{\param double }{f}} Writes the double {\it f} to the stream using the IEEE format. \membersection{wxDataOutputStream::WriteString} -\func{void}{wxDataOutputStream::WriteString}{{\param const wxString\& }{string}} +\func{void}{WriteString}{{\param const wxString\& }{string}} Writes {\it string} to the stream. Actually, this method writes the size of the string before writing {\it string} itself.