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
  16 \wxheading{Derived from}
  17
  18 \helpref{wxInputStream}{wxinputstream}
  19
  20 \wxheading{Include files}
  21
  22 <wx/wfstream.h>
  23
  24 \wxheading{See also}
  25
  26 \helpref{wxBufferedInputStream}{wxbufferedinputstream}, \helpref{wxFileOutputStream}{wxfileoutputstream}, \helpref{wxFFileOutputStream}{wxffileoutputstream}
  27
  28 % ----------
  29 % Members
  30 % ----------
  31 \latexignore{\rtfignore{\wxheading{Members}}}
  32
  33 \membersection{wxFileInputStream::wxFileInputStream}
  34
  35 \func{}{wxFileInputStream}{\param{const wxString\&}{ ifileName}}
  36
  37 Opens the specified file using its {\it ifilename} name in read-only mode.
  38
  39 \func{}{wxFileInputStream}{\param{wxFile\&}{ file}}
  40
  41 Initializes a file stream in read-only mode using the file I/O object {\it file}.
  42
  43 \func{}{wxFileInputStream}{\param{int}{ fd}}
  44
  45 Initializes a file stream in read-only mode using the specified file descriptor.
  46
  47 \membersection{wxFileInputStream::\destruct{wxFileInputStream}}
  48
  49 \func{}{\destruct{wxFileInputStream}}{\void}
  50
  51 Destructor.
  52
  53 \membersection{wxFileInputStream::Ok}
  54
  55 \constfunc{bool}{Ok}{\void}
  56
  57 Returns true if the stream is initialized and ready.
  58