.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxFileInputStream 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxFileInputStream \- 
  File input stream class
 
.SH DESCRIPTION

  


   This class represents data read in from a file. There are actually two such
   groups of classes: this one is based on
   wxFile
   whereas
   wxFFileInputStream
   is based in the
   wxFFile
   class.
  
  


   Note that
   wxFile
   and
   wxFFile
   differ in one aspect, namely when to report that the end of the file has been
   reached. This is documented in
   wxFile::Eof
   and
   wxFFile::Eof
   and the behaviour of the stream classes reflects this difference, i.e.
   wxFileInputStream will report wxSTREAM_EOF after having read the last byte
   whereas wxFFileInputStream will report wxSTREAM_EOF after trying to read
   
    past
   
   the last byte. Related to EOF behavior, note that
   SeekI()
   can seek beyond the end of the stream (file) and will thus not return
   
    wxInvalidOffset
   
   for that.
  
 
.SH "PARENTS"

  wxInputStream
 
.SH "INCLUDE FILES"
wx/wfstream.h
.SH MEMBERS

  
.SS  wxFileInputStream (const wxString& ifileName)

     


      Opens the specified file using its
      
       ifilename
      
      name in read-only mode.
     
    
.SS  wxFileInputStream (wxFile& file)

     


      Initializes a file stream in read-only mode using the file I/O object
      
       file
      
      .
     
    
.SS  wxFileInputStream (int fd)

     


      Initializes a file stream in read-only mode using the specified file
      descriptor.
     
    
   
  
.SS  ~wxFileInputStream ()

     


      Destructor.
     
    
   
  
.SS bool Ok ()

     


      Returns true if the stream is initialized and ready.
     
    
 
.SH "SEE ALSO"

  wxInputStream
 
  wxBufferedInputStream
  wxFileOutputStream
  wxFFileOutputStream
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.