Bzip2 Bean
Properties Methods Events Configuration Settings Errors
The Bzip2 component implements a bzip2 compressor and decompressor. It is compliant with bzip2 specification.
Syntax
IPWorksZip.Bzip2
Remarks
The bzip2 file format is typically used only to archive a single file. Accordingly, the operation of the bean is simpler than that of the other beans.
To compress with the bean, 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 bean 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()ZipControl.ArchiveFile = "c:\test.bz2"ZipControl.FileDecompressedName = "c:\test.txt"ZipControl.Extract()Property List
The following is the full list of the properties of the bean with short descriptions. Click on the links for further details.
| ArchiveFile | The name of the zip, gzip, tar, or jar archive. |
| Bzip2Data | (Decompression only) The bzip2 file contents as a byte array. |
| ExtractToPath | A base path to decompress to. |
| FileDecompressedName | File name to decompress to, or compress from. |
| FileInputData | The data of the file to be compressed. |
| HasMoreData | Shows whether or not there is more data in the bzip2 archive. |
Method List
The following is the full list of the methods of the bean 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. |
| 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. |
| setFileInputStream | The input stream to read the decompressed data from. |
Event List
The following is the full list of the events fired by the bean 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 bean with short descriptions. Click on the links for further details.
| MergeExtractedData | If true, the component will merge concatenated data into one output file when decompressing. |
| WriteToProgressEvent | Whether or not to write data to the Progress Event. |
| CodePage | The system code page used for Unicode to Multibyte translations. |