]>
Commit | Line | Data |
---|---|---|
1 | % ----------------------------------------------------------------------------- | |
2 | % wxFileOutputStream | |
3 | % ----------------------------------------------------------------------------- | |
4 | \section{\class{wxFileOutputStream}}\label{wxfileoutputstream} | |
5 | ||
6 | This class represents data written to a file. There are actually | |
7 | two such groups of classes: this one is based on \helpref{wxFile}{wxfile} | |
8 | whereas \helpref{wxFFileInputStream}{wxffileinputstream} is based in | |
9 | the \helpref{wxFFile}{wxffile} class. | |
10 | ||
11 | Note that \helpref{wxFile}{wxfile} and \helpref{wxFFile}{wxffile} differ | |
12 | in one aspect, namely when to report that the end of the file has been | |
13 | reached. This is documented in \helpref{wxFile::Eof}{wxfileeof} and | |
14 | \helpref{wxFFile::Eof}{wxffileeof} and the behaviour of the stream | |
15 | classes reflects this difference, i.e. wxFileInputStream will report | |
16 | wxSTREAM\_EOF after having read the last byte whereas wxFFileInputStream | |
17 | will report wxSTREAM\_EOF after trying to read {\it past} the last byte. | |
18 | ||
19 | \wxheading{Derived from} | |
20 | ||
21 | \helpref{wxOutputStream}{wxoutputstream} | |
22 | ||
23 | \wxheading{Include files} | |
24 | ||
25 | <wx/wfstream.h> | |
26 | ||
27 | \wxheading{See also} | |
28 | ||
29 | \helpref{wxBufferedOutputStream}{wxbufferedoutputstream}, \helpref{wxFileInputStream}{wxfileinputstream}, \helpref{wxFFileInputStream}{wxffileinputstream} | |
30 | ||
31 | % ---------- | |
32 | % Members | |
33 | % ---------- | |
34 | \latexignore{\rtfignore{\wxheading{Members}}} | |
35 | ||
36 | \membersection{wxFileOutputStream::wxFileOutputStream} | |
37 | ||
38 | \func{}{wxFileOutputStream}{\param{const wxString\&}{ ofileName}} | |
39 | ||
40 | Creates a new file with {\it ofilename} name and initializes the stream in | |
41 | write-only mode. | |
42 | ||
43 | \func{}{wxFileOutputStream}{\param{wxFile\&}{ file}} | |
44 | ||
45 | Initializes a file stream in write-only mode using the file I/O object {\it file}. | |
46 | ||
47 | \func{}{wxFileOutputStream}{\param{int}{ fd}} | |
48 | ||
49 | Initializes a file stream in write-only mode using the file descriptor {\it fd}. | |
50 | ||
51 | \membersection{wxFileOutputStream::\destruct{wxFileOutputStream}} | |
52 | ||
53 | \func{}{\destruct{wxFileOutputStream}}{\void} | |
54 | ||
55 | Destructor. | |
56 | ||
57 | \membersection{wxFileOutputStream::Ok} | |
58 | ||
59 | \constfunc{bool}{Ok}{\void} | |
60 | ||
61 | Returns true if the stream is initialized and ready. | |
62 |