2002-05-02 09:36:23 -04:00
|
|
|
\section{\class{wxFileInputStream}}\label{wxfileinputstream}
|
|
|
|
|
|
|
|
This class represents data read in from a file. There are actually
|
|
|
|
two such groups of classes: this one is based on \helpref{wxFile}{wxfile}
|
|
|
|
whereas \helpref{wxFFileInputStream}{wxffileinputstream} is based in
|
|
|
|
the \helpref{wxFFile}{wxffile} class.
|
|
|
|
|
2005-11-29 09:09:01 -05:00
|
|
|
Note that \helpref{SeekI()}{wxinputstreamseeki}
|
2004-04-11 16:58:56 -04:00
|
|
|
can seek beyond the end of the stream (file) and will thus not return
|
|
|
|
{\it wxInvalidOffset} for that.
|
2002-05-02 09:36:23 -04:00
|
|
|
|
|
|
|
\wxheading{Derived from}
|
|
|
|
|
|
|
|
\helpref{wxInputStream}{wxinputstream}
|
|
|
|
|
|
|
|
\wxheading{Include files}
|
|
|
|
|
|
|
|
<wx/wfstream.h>
|
|
|
|
|
|
|
|
\wxheading{See also}
|
|
|
|
|
|
|
|
\helpref{wxBufferedInputStream}{wxbufferedinputstream}, \helpref{wxFileOutputStream}{wxfileoutputstream}, \helpref{wxFFileOutputStream}{wxffileoutputstream}
|
|
|
|
|
|
|
|
% ----------
|
|
|
|
% Members
|
|
|
|
% ----------
|
|
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
|
|
|
|
2004-09-30 07:15:59 -04:00
|
|
|
\membersection{wxFileInputStream::wxFileInputStream}\label{wxfileinputstreamctor}
|
2002-05-02 09:36:23 -04:00
|
|
|
|
|
|
|
\func{}{wxFileInputStream}{\param{const wxString\&}{ ifileName}}
|
|
|
|
|
|
|
|
Opens the specified file using its {\it ifilename} name in read-only mode.
|
|
|
|
|
|
|
|
\func{}{wxFileInputStream}{\param{wxFile\&}{ file}}
|
|
|
|
|
|
|
|
Initializes a file stream in read-only mode using the file I/O object {\it file}.
|
|
|
|
|
|
|
|
\func{}{wxFileInputStream}{\param{int}{ fd}}
|
|
|
|
|
|
|
|
Initializes a file stream in read-only mode using the specified file descriptor.
|
|
|
|
|
2004-09-30 07:15:59 -04:00
|
|
|
\membersection{wxFileInputStream::\destruct{wxFileInputStream}}\label{wxfileinputstreamdtor}
|
2002-05-02 09:36:23 -04:00
|
|
|
|
|
|
|
\func{}{\destruct{wxFileInputStream}}{\void}
|
|
|
|
|
|
|
|
Destructor.
|
|
|
|
|
2006-10-08 17:56:55 -04:00
|
|
|
\membersection{wxFileInputStream::IsOk}\label{wxfileinputstreamisok}
|
2002-05-02 09:36:23 -04:00
|
|
|
|
2006-10-08 17:56:55 -04:00
|
|
|
\constfunc{bool}{IsOk}{\void}
|
2002-05-02 09:36:23 -04:00
|
|
|
|
2003-01-17 19:16:34 -05:00
|
|
|
Returns true if the stream is initialized and ready.
|
2002-05-02 09:36:23 -04:00
|
|
|
|