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