]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/outptstr.tex
Added config values (commented out) for generating the MS HTML Help
[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\wxheading{See also}
15
16\helpref{wxStreamBuffer}{wxstreambuffer}
17
18% -----------
19% ctor & dtor
20% -----------
21\membersection{wxOutputStream::wxOutputStream}
22
23\func{}{wxOutputStream}{\void}
24
25Creates a dummy wxOutputStream object.
26
27\func{}{wxOutputStream}{\param{wxStreamBuffer*}{ sbuf}}
28
29Creates an input stream using the specified stream buffer \it{sbuf}. This
30stream buffer can point to another stream.
31
32\membersection{wxOutputStream::\destruct{wxOutputStream}}
33
34\func{}{\destruct{wxOutputStream}}{\void}
35
36Destructor.
37
38\membersection{wxOutputStream::OutputStreamBuffer}
39
40\func{wxStreamBuffer *}{OutputStreamBuffer}{\void}
41
42Returns the stream buffer associated with the output stream.
43
44\membersection{wxOutputStream::LastWrite}
45
46\constfunc{size\_t}{LastWrite}{\void}
47
48\membersection{wxOutputStream::PutC}
49
50\func{void}{PutC}{\param{char}{ c}}
51
52Puts the specified character in the output queue and increments the
53stream position.
54
55\membersection{wxOutputStream::SeekO}
56
57\func{off\_t}{SeekO}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode}}
58
59Changes the stream current position.
60
61\membersection{wxOutputStream::TellO}
62
63\constfunc{off\_t}{TellO}{\void}
64
65Returns the current stream position.
66
67\membersection{wxOutputStream::Write}
68
69\func{wxOutputStream\&}{Write}{\param{const void *}{buffer}, \param{size\_t}{ size}}
70
71Writes the specified amount of bytes using the data of \it{buffer}.
72\it{WARNING!} The buffer absolutely needs to have at least the specified size.
73
74This function returns a reference on the current object, so the user can test
75any states of the stream right away.
76
77\func{wxOutputStream\&}{Write}{\param{wxInputStream\&}{ stream\_in}}
78
79Reads data from the specified input stream and stores them
80in the current stream. The data is read until an error is raised
81by one of the two streams.
82