IP*Works! Zip Zip Component : Zip OCX, Zip .NET Component, Zip Class, Zip Bean, Zip Object

Available in: ZIP

Zip Component [IP*Works! ZIP V8]

Properties Methods Events Configuration Settings

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

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The component 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 ArchiveFile property to the name of the archive to be created. Then, specify the files to be compressed either by invoking IncludeFiles, or by adding a new object to the Files collection and setting the values of the Files and Files. fields. Finally, call the Compress method to create the archive.

To decompress an existing archive, set ArchiveFile to the name of the archive to be decompressed. The ExtractToPath property may be set, and then calling the ExtractAll 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 Files may then be changed if desired. Finally, ExtractAll 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 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:\unzipped\" ZipControl.ExtractAll()

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.


ArchiveFile	The name of the zip, gzip, tar, or jar archive.
CompressionLevel	The compression level to use.
EncryptionAlgorithm	The algorithm used to encrypt files written to the archive.
ExcludedFiles	A list of files to exclude.
ExtractToPath	A base path to decompress to.
Files	Collection of Zip archive files.
OverwriteFiles	Whether or not to overwrite files.
Password	A password for the zip archive.
RecurseSubdirectories	Whether or not to recurse into subdirectories.
ZipComment	The comment for the entire zip file.
ZipData	(Decompression only) The zip file contents as a byte array.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.


Abort	Aborts the current operation.
AppendFiles	Adds specified files to an existing archive.
Compress	Creates the compressed archive.
Config	Sets or retrieves a configuration setting.
Delete	Deletes one or more files from an existing archive.
Extract	Extracts a single file, directory, or group of files, from the archive.
ExtractAll	Extracts all files from the compressed archive.
IncludeFiles	Specifies that the indicated files should be added to the archive.
Reset	Resets the component.
Scan	Scans the compressed archive.
SetArchiveInputStream	The stream to read the zip, tar, jar, or gzip archive from.
SetArchiveOutputStream	The stream to write the zip, tar, jar, or gzip archive to.
Update	Will update certain files in an archive.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.


BeginFile	Fired before each file is processed.
EndFile	Fired after each file is processed.
Error	Information about non-fatal errors.
Overwrite	Fired whenever a file exists and may be overwritten.
Password	Fired when a file is encrypted, and the file's password is incorrect.
Progress	Fired as progress is made.

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.


Encoding	Encoding to be used for filenames
ExcludedAttributes	Attributes of files to be excluded
OverwriteReadonlyFiles	Whether to overwrite readonly files
AESGenerateUniqueKeys	Whether to generate unique keys for each file encrypted
Files[i].CompressionLevel	Used to set the compression level for the file at index i
EnableStreamingEncryption	Whether to allow streaming and encryption simultaneously
MarkAsText	Whether to mark files as text files
WriteToProgressEvent	Whether or not to write data to the Progress Event
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only)