ZipObject

Inheritance diagram for ZipObject ↕

Provides access to a zip file.

Public Functions

bool

addFile(string filename, string pathInZip, bool replace)

Add a file to the zip archive.

void

closeArchive()

Close an already opened zip archive.

void

closeFile(SimObject stream)

Close a previously opened file within the zip archive.

bool

deleteFile(string pathInZip)

Deleted the given file from the zip archive.

bool

extractFile(string pathInZip, string filename)

Extact a file from the zip archive and save it to the requested location.

String

getFileEntry(int index)

Get information on the requested file within the zip archive.

int

getFileEntryCount()

Get the number of files within the zip archive.

bool

openArchive(string filename, string accessMode)

Open a zip archive for manipulation.

SimObject

openFileForRead(string filename)

Open a file within the zip archive for reading.

SimObject

openFileForWrite(string filename)

Open a file within the zip archive for writing to.

Detailed Description

Provides access to a zip file.

A ZipObject add, delete and extract files that are within a zip archive. You may also read and write directly to the files within the archive by obtaining a StreamObject for the file.

// Open a zip archive, creating it if it doesn't exist
%archive = new ZipObject();
%archive.openArchive("testArchive.zip", Write);

// Add a file to the archive with the given name
%archive.addFile("./water.png", "water.png");

// Close the archive to save the changes
%archive.closeArchive();

note:
Behind the scenes all of the work is being done with the ZipArchive and StreamObject classes.

see:

StreamObject when using methods such as openFileForRead() and openFileForWrite()

Public Functions

addFile(string filename, string pathInZip, bool replace)

Add a file to the zip archive.

Parameters:

filename	The path and name of the file to add to the zip archive.
pathInZip	The path and name to be given to the file within the zip archive.
replace	If a file already exists within the zip archive at the same location as this new file, this parameter indicates if it should be replaced. By default, it will be replaced.

return:

True if the file was successfully added to the zip archive.

closeArchive()

Close an already opened zip archive.

see:

openArchive()

closeFile(SimObject stream)

Close a previously opened file within the zip archive.

Parameters:

stream

The StreamObject of a previously opened file within the zip archive.

see:

openFileForRead()

see:

openFileForWrite()

deleteFile(string pathInZip)

Deleted the given file from the zip archive.

Parameters:

pathInZip

The path and name of the file to be deleted from the zip archive.

return:

True of the file was successfully deleted.

note:
Files that have been deleted from the archive will still show up with a getFileEntryCount() until you close the archive. If you need to have the file count up to date with only valid files within the archive, you could close and then open the archive again.

see:

getFileEntryCount()

see:

closeArchive()

see:

openArchive()

extractFile(string pathInZip, string filename)

Extact a file from the zip archive and save it to the requested location.

Parameters:

pathInZip	The path and name of the file to be extracted within the zip archive.
filename	The path and name to give the extracted file.

return:

True if the file was successfully extracted.

getFileEntry(int index)

Get information on the requested file within the zip archive.

This methods provides five different pieces of information for the requested file:

filename - The path and name of the file within the zip archive
uncompressed size
compressed size
compression method
CRC32

Use getFileEntryCount() to obtain the total number of files within the archive. Parameters:

index

The index of the file within the zip archive. Use getFileEntryCount() to determine the number of files.

return:

A tab delimited list of information on the requested file, or an empty string if the file could not be found.

see:

getFileEntryCount()

getFileEntryCount()

Get the number of files within the zip archive.

Use getFileEntry() to retrive information on each file within the archive.

return:

The number of files within the zip archive.

note:
The returned count will include any files that have been deleted from the archive using deleteFile(). To clear out all deleted files, you could close and then open the archive again.

see:

getFileEntry()

see:

closeArchive()

see:

openArchive()

openArchive(string filename, string accessMode)

Open a zip archive for manipulation.

Once a zip archive is opened use the various ZipObject methods for working with the files within the archive. Be sure to close the archive when you are done with it.

Parameters: