Search: 
Available in: ZIP
Gzip Component [IP*Works! ZIP V7]

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 FileDecompressedName to the name of the file to be compressed. Finally, invoke Compress. To extract the file, first set ArchiveFile. FileDecompressedName 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.
EnableStreaming Whether or not to enable streaming.
ExtractToPath A base path to decompress to.
FileCompressedDate The date and time of the compressed file, as stored within the gzip archive.
FileCompressedName Filename, as stored inside of the archive.
FileDecompressedName File name to decompress to, or compress from.
HasMoreData Shows whether or not there is more data in the gzip archive.

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.
Compress Creates the compressed gzip archive.
Config Sets or retrieves a component configuration setting.
Extract Extracts the compressed file from the gzip archive.
ExtractAll Extracts all files from the compressed archive.
Scan Scans the compressed archive.

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 a file is processed.
EndFile Fired after a 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.

| About | Privacy Policy | Terms of Use |
© Copyright 2008 /n software inc.