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

\section{\class{wxDataStream}}\label{wxdatastream}

This class provides functions that read and write integers or double in a
portable way. So, a file written by an Intel processor can be read by a
Sparc or anything else.

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxDataStream::wxDataStream}\label{wxdatastreamconstr}

\func{}{wxDataStream}{\param{istream\&}{ stream}}

Constructs a datastream object from a C++ input stream. Only read methods will
be available.

\wxheading{Parameters}

\docparam{stream}{The C++ input stream.}

\func{}{wxDataStream}{\param{istream\&}{ stream}}

Constructs a datastream object from a C++ input stream. Only read methods will
be available.

\wxheading{Parameters}

\docparam{stream}{The C++ input stream.}

\membersection{wxDataStream::\destruct{wxDataStream}}

\func{}{\destruct{wxDataStream}}{\void}

Destroys the wxDataStream object.

\membersection{wxDataStream::Read8}

\func{unsigned char}{Read8}{\void}

Reads a single byte from the stream.

\membersection{wxDataStream::Read16}

\func{unsigned short}{Read16}{\void}

Reads a 16 bit integer from the stream.

\membersection{wxDataStream::Read32}

\func{unsigned long}{Read32}{\void}

Reads a 32 bit integer from the stream.

\membersection{wxDataStream::ReadDouble}

\func{double}{ReadDouble}{\void}

Reads a double (IEEE encoded) from the stream.

\membersection{wxDataStream::ReadString}

\func{wxString}{wxDataStream::ReadString}{\void}

Reads a string from a stream. Actually, this function first reads a byte
specifying the length of the string (without the last null character) and then
reads the string.

\membersection{wxDataStream::ReadLine}

\func{wxString}{wxDataStream::ReadLine}{\void}

Reads a line from the stream. A line is a string which ends with \\n or \\r\\n.

\membersection{wxDataStream::Write8}

\func{void}{wxDataStream::Write8}{{\param unsigned char }{i8}}

Writes the single byte {\it i8} to the stream.

\membersection{wxDataStream::Write16}

\func{void}{wxDataStream::Write16}{{\param unsigned short }{i16}}

Writes the 16 bit integer {\it i16} to the stream.

\membersection{wxDataStream::Write32}

\func{void}{wxDataStream::Write32}{{\param unsigned long }{i32}}

Writes the 32 bit integer {\it i32} to the stream.

\membersection{wxDataStream::WriteDouble}

\func{void}{wxDataStream::WriteDouble}{{\param double }{f}}

Writes the double {\it f} to the stream using the IEEE format.

\membersection{wxDataStream::WriteString}

\func{void}{wxDataStream::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.

\membersection{wxDataStream::WriteLine}

\func{void}{wxDataStream::WriteLine}{{\param const wxString\& }{string}}

Writes {\it string} as a line. Depending on the operating system, it adds
\\n or \\r\\n.

%%% Local Variables: 
%%% mode: latex
%%% TeX-master: "referenc"
%%% End:
Commit	Line	Data
4d1f281b GL	1	\section{\class{wxDataStream}}\label{wxdatastream}
	2
	3	This class provides functions that read and write integers or double in a
	4	portable way. So, a file written by an Intel processor can be read by a
	5	Sparc or anything else.
	6
	7	\latexignore{\rtfignore{\wxheading{Members}}}
	8
f7bd2698	9	\membersection{wxDataStream::wxDataStream}\label{wxdatastreamconstr}
4d1f281b GL	10
	11	\func{}{wxDataStream}{\param{istream\&}{ stream}}
	12
	13	Constructs a datastream object from a C++ input stream. Only read methods will
	14	be available.
	15
	16	\wxheading{Parameters}
	17
	18	\docparam{stream}{The C++ input stream.}
	19
	20	\func{}{wxDataStream}{\param{istream\&}{ stream}}
	21
	22	Constructs a datastream object from a C++ input stream. Only read methods will
	23	be available.
	24
	25	\wxheading{Parameters}
	26
	27	\docparam{stream}{The C++ input stream.}
	28
	29	\membersection{wxDataStream::\destruct{wxDataStream}}
	30
	31	\func{}{\destruct{wxDataStream}}{\void}
	32
	33	Destroys the wxDataStream object.
	34
	35	\membersection{wxDataStream::Read8}
	36
	37	\func{unsigned char}{Read8}{\void}
	38
	39	Reads a single byte from the stream.
	40
	41	\membersection{wxDataStream::Read16}
	42
	43	\func{unsigned short}{Read16}{\void}
	44
	45	Reads a 16 bit integer from the stream.
	46
	47	\membersection{wxDataStream::Read32}
	48
	49	\func{unsigned long}{Read32}{\void}
	50
	51	Reads a 32 bit integer from the stream.
	52
	53	\membersection{wxDataStream::ReadDouble}
	54
	55	\func{double}{ReadDouble}{\void}
	56
	57	Reads a double (IEEE encoded) from the stream.
	58
	59	\membersection{wxDataStream::ReadString}
	60
	61	\func{wxString}{wxDataStream::ReadString}{\void}
	62
	63	Reads a string from a stream. Actually, this function first reads a byte
	64	specifying the length of the string (without the last null character) and then
	65	reads the string.
	66
	67	\membersection{wxDataStream::ReadLine}
	68
	69	\func{wxString}{wxDataStream::ReadLine}{\void}
	70
	71	Reads a line from the stream. A line is a string which ends with \\n or \\r\\n.
	72
	73	\membersection{wxDataStream::Write8}
74
75	\func{void}{wxDataStream::Write8}{{\param unsigned char }{i8}}
76
77	Writes the single byte {\it i8} to the stream.
78
79	\membersection{wxDataStream::Write16}
80
81	\func{void}{wxDataStream::Write16}{{\param unsigned short }{i16}}
82
83	Writes the 16 bit integer {\it i16} to the stream.
84
85	\membersection{wxDataStream::Write32}
86
87	\func{void}{wxDataStream::Write32}{{\param unsigned long }{i32}}
88
89	Writes the 32 bit integer {\it i32} to the stream.
90
91	\membersection{wxDataStream::WriteDouble}
92
93	\func{void}{wxDataStream::WriteDouble}{{\param double }{f}}
94
95	Writes the double {\it f} to the stream using the IEEE format.
96
97	\membersection{wxDataStream::WriteString}
98
e14dccff	99	\func{void}{wxDataStream::WriteString}{{\param const wxString\& }{string}}
4d1f281b GL	100
	101	Writes {\it string} to the stream. Actually, this method writes the size of
	102	the string before writing {\it string} itself.
	103
	104	\membersection{wxDataStream::WriteLine}
	105
e14dccff	106	\func{void}{wxDataStream::WriteLine}{{\param const wxString\& }{string}}
4d1f281b GL	107
	108	Writes {\it string} as a line. Depending on the operating system, it adds
	109	\\n or \\r\\n.
e14dccff KB	110
	111	%%% Local Variables:
	112	%%% mode: latex
	113	%%% TeX-master: "referenc"
	114	%%% End: