GroupFile Class Reference

#include <groupfile.h>

List of all members.

Public Methods

 GroupFile (const char *filename)
 GroupFile ()
 ~GroupFile ()
int Load ()
int Save ()
void SetFilename (const char *sFilename)
char * GetFileName ()
uint32 GetNumFiles ()
FILESTRUCTGetFileEntry (uint32 nEntry)
ErrorCode AddFile (char *sFilename)
ErrorCode RemoveFile (char *sFilename)
int GetStatus ()

Protected Methods

int Open (const char *sFlags)
int Close ()

Protected Attributes

char m_sFileName [256]
char m_sAuthorName [12]
uint32 m_nNumFiles
LinkedList< FILESTRUCTm_Files
FILE * m_pFilePointer
int m_nStatus


Detailed Description

This class is used to deal with GRP files.

Definition at line 10 of file groupfile.h.


Constructor & Destructor Documentation

GroupFile::GroupFile const char *    filename
 

Load a GroupFile from disk

Definition at line 8 of file groupfile.cpp.

GroupFile::GroupFile  
 

Create an empty GroupFile

Definition at line 24 of file groupfile.cpp.

GroupFile::~GroupFile  
 

Definition at line 34 of file groupfile.cpp.


Member Function Documentation

ErrorCode GroupFile::AddFile char *    sFilename
 

Add a file to the Group File. Do not forget that the filename is to be 8.3

int GroupFile::Close   [protected]
 

Definition at line 147 of file groupfile.cpp.

FILESTRUCT* GroupFile::GetFileEntry uint32    nEntry [inline]
 

Get a particular file entry. If the requested entry is outside the bounds of the array, NULL is returned.

Definition at line 40 of file groupfile.h.

char* GroupFile::GetFileName   [inline]
 

Get the filename of the GroupFile

Definition at line 32 of file groupfile.h.

uint32 GroupFile::GetNumFiles   [inline]
 

Get the number of file in this GroupFile

Definition at line 35 of file groupfile.h.

int GroupFile::GetStatus   [inline]
 

Return the current status of the Groupfile. This is used to find out if any errors occured during the loading of a GroupFile.

Definition at line 61 of file groupfile.h.

int GroupFile::Load  
 

Load a Groupfile

Definition at line 65 of file groupfile.cpp.

int GroupFile::Open const char *    sFlags [protected]
 

Definition at line 53 of file groupfile.cpp.

ErrorCode GroupFile::RemoveFile char *    sFilename
 

Remove an entry from the Group File by filename

int GroupFile::Save  
 

Save the group file

Definition at line 108 of file groupfile.cpp.

void GroupFile::SetFilename const char *    sFilename
 

Set the filename for the GroupFile

Definition at line 158 of file groupfile.cpp.


Member Data Documentation

LinkedList<FILESTRUCT> GroupFile::m_Files [protected]
 

File data

Definition at line 79 of file groupfile.h.

uint32 GroupFile::m_nNumFiles [protected]
 

Total number of files in the GroupFile archive

Definition at line 75 of file groupfile.h.

int GroupFile::m_nStatus [protected]
 

Current status of the GroupFile

Definition at line 85 of file groupfile.h.

FILE* GroupFile::m_pFilePointer [protected]
 

File pointer for the current GroupFile

Definition at line 82 of file groupfile.h.

char GroupFile::m_sAuthorName[12] [protected]
 

Author name of the GroupFile format. This should always be set to KENSILVERMAN.

Definition at line 72 of file groupfile.h.

char GroupFile::m_sFileName[256] [protected]
 

Filename of the GroupFile

Definition at line 69 of file groupfile.h.


The documentation for this class was generated from the following files:
Generated on Sat Jan 11 23:36:58 2003 for Build-Lib by doxygen1.2.18