.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxFFile 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxFFile \- 
  Another low-level file input/output class.
 
.SH DESCRIPTION

  


   wxFFile implements buffered file I/O. This is a very small class designed to
   minimize the overhead of using it - in fact, there is hardly any overhead at
   all, but using it brings you automatic error checking and hides differences
   between platforms and compilers. It wraps inside it a
   FILE *
   handle used by standard C IO library (also known as
   stdio
   ).
  
 
.SH "PARENTS"

.SH "INCLUDE FILES"
wx/ffile.h
.SH MEMBERS

  
.SS  wxFFile ()

     


      Default constructor.
     
    
.SS  wxFFile (const char* filenameconst char* mode = "r")

     


      Opens a file with the given mode. As there is no way to return whether the
      operation was successful or not from the constructor you should test the
      return value of
      IsOpened
      to check that it didn't fail.
     
    
.SS  wxFFile (FILE* fp)

     


      Opens a file with the given file pointer, which has already been opened.
     
    
   
  
.SS  ~wxFFile ()

     


      Destructor will close the file.
     
     


      NB: it is not virtual so you should
      
       not
      
      derive from wxFFile!
     
    
   
  
.SS void Attach (FILE* fp)

     


      Attaches an existing file pointer to the wxFFile object.
     
     


      The descriptor should be already opened and it will be closed by wxFFile
      object.
     
    
   
  
.SS bool Close ()

     


      Closes the file and returns true on success.
     
    
   
  
.SS void Detach ()

     


      Get back a file pointer from wxFFile object -- the caller is responsible
      for closing the file if this descriptor is opened.
      IsOpened()
      will return false after call to Detach().
     
    
   
  
.SS FILE * fp ()

     


      Returns the file pointer associated with the file.
     
    
   
  
.SS bool Eof ()

     


      Returns true if the an attempt has been made to read
      
       past
      
      the end of the file.
     
     


      Note that the behaviour of the file descriptor based class
      wxFile
      is different as
      wxFile::Eof
      will return true here as soon as the last byte of the file has been read.
     
     


      Also note that this method may only be called for opened files and may
      crash if the file is not opened.
     
    
   
  
   
  
.SS bool Flush ()

     


      Flushes the file and returns true on success.
     
    
   
  
.SS wxFileKind GetKind ()

     


      Returns the type of the file. Possible return values are:
     
     
enum wxFileKind
{
  wxFILE_KIND_UNKNOWN,
  wxFILE_KIND_DISK,     // a file supporting seeking to arbitrary offsets
  wxFILE_KIND_TERMINAL, // a tty
  wxFILE_KIND_PIPE      // a pipe
};


    
   
  
.SS bool IsOpened ()

     


      Returns true if the file is opened. Most of the methods of this class may
      only be used for an opened file.
     
    
   
  
.SS wxFileOffset Length ()

     


      Returns the length of the file.
     
    
   
  
.SS bool Open (const char* filenameconst char* mode = "r")

     


      Opens the file, returning true if successful.
     
    
   
  
.SS size_t Read (void* buffersize_t count)

     


      Reads the specified number of bytes into a buffer, returning the actual
      number read.
     
    
   
  
.SS bool ReadAll (wxString * strwxMBConv& conv = wxConvUTF8)

     


      Reads the entire contents of the file into a string.
     
    
   
  
.SS bool Seek (wxFileOffset ofswxSeekMode mode = wxFromStart)

     


      Seeks to the specified position and returns true on success.
     
    
   
  
.SS bool SeekEnd (wxFileOffset ofs = 0)

     


      Moves the file pointer to the specified number of bytes before the end of
      the file and returns true on success.
     
    
   
  
.SS wxFileOffset Tell ()

     


      Returns the current position.
     
    
   
  
.SS size_t Write (const void* buffersize_t count)

     


      Writes the specified number of bytes from a buffer.
     
    
.SS bool Write (const wxString& swxMBConv& conv = wxConvUTF8)

     


      Writes the contents of the string to the file
     
    
 
.SH "SEE ALSO"

.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.