Bzip2 Component [IP*Works! ZIP V8]
Properties
Methods
Events
Configuration Settings
The Bzip2 component implements a bzip2 compressor and decompressor. It is compliant with the
bzip2 specification.
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 bzip2 file format is typically 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 bzip2 file to be created, and FileDecompressedName to the
name of the file to be compressed. Finally, invoke Compress. To extract the file,
set ArchiveFile to the bzip2 archive and FileDecompressedName to the file where the
component should extract. Finally, invoke the Extract
or Compress method.
Example (Creating a Bzip2 File)
ZipControl.ArchiveFile = "c:\test.bz2"
ZipControl.FileDecompressedName = "c:\test.txt"
ZipControl.Compress()
Example (Extracting from a Bzip2 File)
ZipControl.ArchiveFile = "c:\test.bz2"
ZipControl.FileDecompressedName = "c:\test.txt"
ZipControl.Extract()
This component is an implementation based on Julian Seward's bzip2 library (http://www.bzip.org).
Property List
The following is the full list of the properties of the component with short
descriptions. Click on the links for further details.
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. |
| Append | Adds specified file to an existing archive. |
| Compress | Creates the compressed bzip2 archive. |
| Config | Sets or retrieves a configuration setting. |
| Extract | Extracts the compressed file from the bzip2 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 further details.
| |
| 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. |
Configuration Settings
The following is a list of configuration settings for the component with short
descriptions. Click on the links for further details.
| |
| WriteToProgressEvent | Whether or not to write data to the Progress Event. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
