]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/fileistr.tex
document Cmp[NoCase]() overloads taking wxString too (bug 1198423)
[wxWidgets.git] / docs / latex / wx / fileistr.tex
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{wxFile}{wxfile} and \helpref{wxFFile}{wxffile} differ
9 in one aspect, namely when to report that the end of the file has been
10 reached. This is documented in \helpref{wxFile::Eof}{wxfileeof} and
11 \helpref{wxFFile::Eof}{wxffileeof} and the behaviour of the stream
12 classes reflects this difference, i.e. wxFileInputStream will report
13 wxSTREAM\_EOF after having read the last byte whereas wxFFileInputStream
14 will report wxSTREAM\_EOF after trying to read {\it past} the last byte.
15 Related to EOF behavior, note that \helpref{SeekI()}{wxinputstreamseeki}
16 can seek beyond the end of the stream (file) and will thus not return
17 {\it wxInvalidOffset} for that.
18
19 \wxheading{Derived from}
20
21 \helpref{wxInputStream}{wxinputstream}
22
23 \wxheading{Include files}
24
25 <wx/wfstream.h>
26
27 \wxheading{See also}
28
29 \helpref{wxBufferedInputStream}{wxbufferedinputstream}, \helpref{wxFileOutputStream}{wxfileoutputstream}, \helpref{wxFFileOutputStream}{wxffileoutputstream}
30
31 % ----------
32 % Members
33 % ----------
34 \latexignore{\rtfignore{\wxheading{Members}}}
35
36 \membersection{wxFileInputStream::wxFileInputStream}\label{wxfileinputstreamctor}
37
38 \func{}{wxFileInputStream}{\param{const wxString\&}{ ifileName}}
39
40 Opens the specified file using its {\it ifilename} name in read-only mode.
41
42 \func{}{wxFileInputStream}{\param{wxFile\&}{ file}}
43
44 Initializes a file stream in read-only mode using the file I/O object {\it file}.
45
46 \func{}{wxFileInputStream}{\param{int}{ fd}}
47
48 Initializes a file stream in read-only mode using the specified file descriptor.
49
50 \membersection{wxFileInputStream::\destruct{wxFileInputStream}}\label{wxfileinputstreamdtor}
51
52 \func{}{\destruct{wxFileInputStream}}{\void}
53
54 Destructor.
55
56 \membersection{wxFileInputStream::Ok}\label{wxfileinputstreamok}
57
58 \constfunc{bool}{Ok}{\void}
59
60 Returns true if the stream is initialized and ready.
61