Main Page | Class Hierarchy | Class List | Directories | File List | Class Members | File Members | Related Pages

GFile Class Reference

Generic file access class. More...

#include <GFile.h>

Inheritance diagram for GFile:

GStream GDom GFilter GTempFile MFile GdcBmp List of all members.

Public Member Functions

int Open (char *Name, int Attrib)
 Opens a file.
bool IsOpen ()
 Returns non zero if the class is associated with an open file handle.
int Close ()
 Closes the file.
int GetOpenMode ()
 Gets the mode that the file was openned with.
int64 GetPos ()
 Gets the current file pointer.
int64 SetPos (int64 Pos)
 Sets the current file pointer.
int64 GetSize ()
 Gets the file size.
int64 SetSize (int64 Size)
 Sets the file size.
int Read (void *Buffer, int Size, int Flags=0)
 Reads bytes into memory from the current file pointer.
int Write (void *Buffer, int Size, int Flags=0)
 Writes bytes from memory to the current file pointer.
virtual char * GetName ()
 Gets the path used to open the file.
virtual int64 Seek (int64 To, int Whence)
 Moves the current file pointer.
virtual bool Eof ()
 Returns true if the current file pointer is at the end of the file.
virtual void SetStatus (bool s=false)
 Resets the status value.
virtual bool GetStatus ()
 Returns true if all operations were successful since the file was openned or SetStatus was used to reset the file's status.
virtual void SetSwap (bool s)
 Sets the swap option. When switched on all integer reads/writes will have their bytes swaped.
virtual bool GetSwap ()
 Gets the current swap setting.
virtual bool Open (char *Name, int Attrib)
virtual bool Close ()
virtual int GetSize ()
 Gets the size of the stream.
int Print (char *Format,...)
 Formats a string and then writes it.

Detailed Description

Generic file access class.


Member Function Documentation

virtual bool GFile::Close  )  [virtual]
 

Closes the connection

Returns:
> zero on success

Reimplemented from GStream.

Reimplemented in MFile.

int64 GFile::GetPos  )  [virtual]
 

Gets the current file pointer.

Returns:
The file pointer or -1 on error.

Reimplemented from GStream.

Reimplemented in MFile.

virtual int GFile::GetSize  )  [virtual]
 

Gets the size of the stream.

Returns:
The size or -1 on error (e.g. the information is not available)

Reimplemented from GStream.

Reimplemented in MFile.

int64 GFile::GetSize  )  [virtual]
 

Gets the file size.

Returns:
The file size or -1 on error.

Reimplemented from GStream.

Reimplemented in MFile.

virtual bool GFile::Open char *  Name,
int  Attrib
[virtual]
 

Open a connection

Returns:
> zero on success

Reimplemented from GStream.

Reimplemented in MFile.

int GFile::Open char *  Name,
int  Attrib
[virtual]
 

Opens a file.

Returns:
Non zero on success
Parameters:
File  The path of the file to open
Mode  The mode to open the file with. One of O_READ, O_WRITE or O_READWRITE.

Reimplemented from GStream.

Reimplemented in MFile.

int GFile::Read void *  Buffer,
int  Size,
int  Flags = 0
[virtual]
 

Reads bytes into memory from the current file pointer.

Returns:
The number of bytes read or <= 0.

Reimplemented from GStream.

Reimplemented in MFile.

int64 GFile::SetPos int64  Pos  )  [virtual]
 

Sets the current file pointer.

Returns:
The new file pointer or -1 on error.

Reimplemented from GStream.

Reimplemented in MFile.

int64 GFile::SetSize int64  Size  )  [virtual]
 

Sets the file size.

Returns:
The new file size or -1 on error.

Reimplemented from GStream.

Reimplemented in MFile.

int GFile::Write void *  Buffer,
int  Size,
int  Flags = 0
[virtual]
 

Writes bytes from memory to the current file pointer.

Returns:
The number of bytes written or <= 0.

Reimplemented from GStream.

Reimplemented in MFile.


The documentation for this class was generated from the following files:
Generated on Wed Oct 26 14:46:58 2005 for Lgi by  doxygen 1.4.1