Zip Library


Data Structures

struct  pgeZipFile

Typedefs

typedef void pgeZip

Functions

pgeZippgeZipOpen (const char *filename)
int pgeZipClose (pgeZip *zip)
pgeZipFilepgeZipFileRead (pgeZip *zip, const char *filename, const char *password)
int pgeZipExtract (pgeZip *zip, const char *password)
void pgeZipFileFree (pgeZipFile *file)

Typedef Documentation

typedef void pgeZip

A zip


Function Documentation

int pgeZipClose ( pgeZip zip  ) 

Close a Zip file

Parameters:
zip - A valid (previously opened) pgeZip
Returns:
1 on success, 0 on error

int pgeZipExtract ( pgeZip zip,
const char *  password 
)

Extract all files from a zip

Parameters:
zip - A valid (previously opened) pgeZip file
password - The password of the file (pass NULL if no password)
Returns:
1 on success, 0 on error.

void pgeZipFileFree ( pgeZipFile file  ) 

Free the file data previously loaded from a zip

Parameters:
file - A valid (previously read) pgeZipFile

pgeZipFile* pgeZipFileRead ( pgeZip zip,
const char *  filename,
const char *  password 
)

Read a file from a zip

Parameters:
zip - A valid (previously opened) pgeZip
filename - The file to read within the zip
password - The password of the file (pass NULL if no password)
Returns:
A pgeZipFile struct containing the file

pgeZip* pgeZipOpen ( const char *  filename  ) 

Open a Zip file

Parameters:
filename - Path of the zip to load.
Returns:
A pointer to a pgeZip struct or NULL on error.


Generated on Mon Sep 22 16:58:14 2008 for Phoenix Game Engine by  doxygen 1.5.5