]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/fileistr.tex
Limit indentation in style listbox, and also show centring
[wxWidgets.git] / docs / latex / wx / fileistr.tex
CommitLineData
1106d865
VZ
1\section{\class{wxFileInputStream}}\label{wxfileinputstream}
2
3This class represents data read in from a file. There are actually
4two such groups of classes: this one is based on \helpref{wxFile}{wxfile}
5whereas \helpref{wxFFileInputStream}{wxffileinputstream} is based in
6the \helpref{wxFFile}{wxffile} class.
7
bf085665 8Note that \helpref{SeekI()}{wxinputstreamseeki}
a84e46f2
VS
9can seek beyond the end of the stream (file) and will thus not return
10{\it wxInvalidOffset} for that.
1106d865
VZ
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
b236c10f 29\membersection{wxFileInputStream::wxFileInputStream}\label{wxfileinputstreamctor}
1106d865
VZ
30
31\func{}{wxFileInputStream}{\param{const wxString\&}{ ifileName}}
32
33Opens the specified file using its {\it ifilename} name in read-only mode.
34
35\func{}{wxFileInputStream}{\param{wxFile\&}{ file}}
36
37Initializes a file stream in read-only mode using the file I/O object {\it file}.
38
39\func{}{wxFileInputStream}{\param{int}{ fd}}
40
41Initializes a file stream in read-only mode using the specified file descriptor.
42
b236c10f 43\membersection{wxFileInputStream::\destruct{wxFileInputStream}}\label{wxfileinputstreamdtor}
1106d865
VZ
44
45\func{}{\destruct{wxFileInputStream}}{\void}
46
47Destructor.
48
b7cacb43 49\membersection{wxFileInputStream::IsOk}\label{wxfileinputstreamisok}
1106d865 50
b7cacb43 51\constfunc{bool}{IsOk}{\void}
1106d865 52
cc81d32f 53Returns true if the stream is initialized and ready.
1106d865 54