]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/outptstr.tex
1. wxHtmlHelpController and related classes
[wxWidgets.git] / docs / latex / wx / outptstr.tex
... / ...
CommitLineData
1% -----------------------------------------------------------------------------
2% wxOutputStream
3% -----------------------------------------------------------------------------
4\section{\class{wxOutputStream}}\label{wxoutputstream}
5
6\wxheading{Derived from}
7
8\helpref{wxStreamBase}{wxstreambase}
9
10\wxheading{Include files}
11
12<wx/stream.h>
13
14% -----------
15% ctor & dtor
16% -----------
17\membersection{wxOutputStream::wxOutputStream}
18
19\func{}{wxOutputStream}{\void}
20
21Creates a dummy wxOutputStream object.
22
23\membersection{wxOutputStream::\destruct{wxOutputStream}}
24
25\func{}{\destruct{wxOutputStream}}{\void}
26
27Destructor.
28
29\membersection{wxOutputStream::LastWrite}
30
31\constfunc{size\_t}{LastWrite}{\void}
32
33\membersection{wxOutputStream::PutC}
34
35\func{void}{PutC}{\param{char}{ c}}
36
37Puts the specified character in the output queue and increments the
38stream position.
39
40\membersection{wxOutputStream::SeekO}
41
42\func{off\_t}{SeekO}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode}}
43
44Changes the stream current position.
45
46\membersection{wxOutputStream::TellO}
47
48\constfunc{off\_t}{TellO}{\void}
49
50Returns the current stream position.
51
52\membersection{wxOutputStream::Write}
53
54\func{wxOutputStream\&}{Write}{\param{const void *}{buffer}, \param{size\_t}{ size}}
55
56Writes the specified amount of bytes using the data of \it{buffer}.
57\it{WARNING!} The buffer absolutely needs to have at least the specified size.
58
59This function returns a reference on the current object, so the user can test
60any states of the stream right away.
61
62\func{wxOutputStream\&}{Write}{\param{wxInputStream\&}{ stream\_in}}
63
64Reads data from the specified input stream and stores them
65in the current stream. The data is read until an error is raised
66by one of the two streams.
67