Zip Class

Properties   Methods   Events   Configuration Settings   Errors  

The Zip class implements a PKZip-compatible Zip compressor and decompressor.

Syntax

class ipworkszip.Zip

Remarks

The class uses the Deflate algorithm specified in RFC 1951 for compression, and produces and reads output compatible with PKZip, WinZip, etc.

To create a new archive, first set the archive_file property to the name of the archive to be created. Then, specify the files to be compressed either by invoking include_files, or by adding a new object to the files collection and setting the values of the file_decompressed_name and file_compressed_name. fields. Finally, call the compress method to create the archive.

To decompress an existing archive, set archive_file to the name of the archive to be decompressed. The extract_to_path property may be set, and then calling the extract_all method will decompress all files in the archive to this path.

For finer control, the scan method should be used to read the file information stored in the archive. This will fill out the information in the files collection. The values of file_decompressed_name may then be changed if desired. Finally, extract_all may be used to decompress the entire archive, or extract may be used for finer control.

Data may be streamed out by setting WriteToProgressEvent to true. Then, the on_progress event may be trapped to retrieve the data.

Example (Creating an Archive)

ZipControl.ArchiveFile = "c:\test.zip"
ZipControl.RecurseSubdirectories = true
ZipControl.IncludeFiles("c:\foo\*")
ZipControl.Compress()

Example (Extracting from an Archive)

ZipControl.ArchiveFile = "c:\temp.zip"
ZipControl.ExtractToPath = "c:\extracted\"
ZipControl.ExtractAll()