Bzip2 Class

Properties   Methods   Events   Configuration Settings   Errors  

The Bzip2 component implements a bzip2 compressor and decompressor. It is compliant with bzip2 specification.

Class Name

IPWorksZip_Bzip2

Procedural Interface

 ipworkszip_bzip2_open();
 ipworkszip_bzip2_close($res);
 ipworkszip_bzip2_register_callback($res, $id, $function);
 ipworkszip_bzip2_get_last_error($res);
 ipworkszip_bzip2_get_last_error_code($res);
 ipworkszip_bzip2_set($res, $id, $index, $value);
 ipworkszip_bzip2_get($res, $id, $index);
 ipworkszip_bzip2_do_abort($res);
 ipworkszip_bzip2_do_append($res);
 ipworkszip_bzip2_do_compress($res);
 ipworkszip_bzip2_do_config($res, $configurationstring);
 ipworkszip_bzip2_do_extract($res);
 ipworkszip_bzip2_do_extractall($res);
 ipworkszip_bzip2_do_reset($res);
 ipworkszip_bzip2_do_scan($res);

Remarks

The bzip2 file format is typically used only to archive a single file. Accordingly, the operation of the class is simpler than that of the other classs.

To compress with the class, 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 class should extract. Finally, invoke the Extract or Compress method.

Example (Creating a Bzip2 File)

This class is an implementation based on Julian Seward's bzip2 library (http://www.bzip.org).