]>
Commit | Line | Data |
---|---|---|
1 | \section{\class{wxFileInputStream}}\label{wxfileinputstream} | |
2 | ||
3 | This class represents data read in from a file. There are actually | |
4 | two such groups of classes: this one is based on \helpref{wxFile}{wxfile} | |
5 | whereas \helpref{wxFFileInputStream}{wxffileinputstream} is based in | |
6 | the \helpref{wxFFile}{wxffile} class. | |
7 | ||
8 | Note that \helpref{SeekI()}{wxinputstreamseeki} | |
9 | can seek beyond the end of the stream (file) and will thus not return | |
10 | {\it wxInvalidOffset} for that. | |
11 | ||
12 | \wxheading{Derived from} | |
13 | ||
14 | \helpref{wxInputStream}{wxinputstream} | |
15 | ||
16 | \wxheading{Include files} | |
17 | ||
18 | <wx/wfstream.h> | |
19 | ||
20 | \wxheading{See also} | |
21 | ||
22 | \helpref{wxBufferedInputStream}{wxbufferedinputstream}, \helpref{wxFileOutputStream}{wxfileoutputstream}, \helpref{wxFFileOutputStream}{wxffileoutputstream} | |
23 | ||
24 | % ---------- | |
25 | % Members | |
26 | % ---------- | |
27 | \latexignore{\rtfignore{\wxheading{Members}}} | |
28 | ||
29 | \membersection{wxFileInputStream::wxFileInputStream}\label{wxfileinputstreamctor} | |
30 | ||
31 | \func{}{wxFileInputStream}{\param{const wxString\&}{ ifileName}} | |
32 | ||
33 | Opens the specified file using its {\it ifilename} name in read-only mode. | |
34 | ||
35 | \func{}{wxFileInputStream}{\param{wxFile\&}{ file}} | |
36 | ||
37 | Initializes a file stream in read-only mode using the file I/O object {\it file}. | |
38 | ||
39 | \func{}{wxFileInputStream}{\param{int}{ fd}} | |
40 | ||
41 | Initializes a file stream in read-only mode using the specified file descriptor. | |
42 | ||
43 | \membersection{wxFileInputStream::\destruct{wxFileInputStream}}\label{wxfileinputstreamdtor} | |
44 | ||
45 | \func{}{\destruct{wxFileInputStream}}{\void} | |
46 | ||
47 | Destructor. | |
48 | ||
49 | \membersection{wxFileInputStream::Ok}\label{wxfileinputstreamok} | |
50 | ||
51 | \constfunc{bool}{Ok}{\void} | |
52 | ||
53 | Returns true if the stream is initialized and ready. | |
54 |