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

Available in: ZIP

Gzip Class

Gzip Component [IP*Works! ZIP V8]

Properties Methods Events Configuration Settings

The Gzip component implements a gzip compressor and decompressor, compliant to RFC 1952 and compatible with the UNIX gzip and gunzip utilities.

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 gzip file format used only to archive a single file. Accordingly, the operation of the component is simpler than that of the other components.

To compress with the component, set ArchiveFile to the name of the gzip file to be created, and TBD - rpFileDecompressedName; to the name of the file to be compressed. Finally, invoke Compress. To extract the file, first set ArchiveFile. TBD - rpFileDecompressedName; may then be set; if not, it will automatically be set from the gzip file headers. Finally, invoke the Extract or Compress method.

.tar.gz files may be created or extracted in one step by using the Tar component. See the documentation for Tar for more details.

Example (Creating a Gzip File)

ZipControl.ArchiveFile = "c:\test.gz" ZipControl.FileDecompressedName = "c:\test.txt" ZipControl.Compress()
Example (Extracting from a Gzip File)

ZipControl.ArchiveFile = "c:\test.gz" ZipControl.FileDecompressedName = "c:\test.txt" ZipControl.Extract()

Property List

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


ArchiveFile	The name of the zip, gzip, tar, or jar archive.
CompressionLevel	The compression level to use.
CompressionMethod	TBD.
ExcludedFiles	A list of files to exclude.
ExtractToPath	A base path to decompress to.
Files	Collection of Gzip archive files.
OverwriteFiles	Whether or not to overwrite files.
RecurseSubdirectories	Whether or not to recurse into subdirectories.

Method List

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


Abort	Aborts the current operation.
AppendFiles	Adds specified files to an existing archive.
Compress	Creates the compressed archive.
Config	Sets or retrieves a component 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.
SetArchiveStream	The stream to write the zip, tar, or jar archive to.

Event List

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


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.
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 complete descriptions.


EnableStreaming	Whether or not to enable streaming.