Bzip2 Component

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

nsoftware.IPWorksZip.Bzip2

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()

Property List


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

ArchiveFileThe name of the zip, gzip, tar, or jar archive.
Bzip2Data(Decompression only) The bzip2 file contents as a byte array.
ExtractToPathA base path to decompress to.
FileDecompressedNameFile name to decompress to, or compress from.
FileInputDataThe data of the file to be compressed.
HasMoreDataShows whether or not there is more data in the bzip2 archive.

Method List


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

AbortAborts the current operation.
AppendAdds specified file to an existing archive.
CompressCreates the compressed bzip2 archive.
ConfigSets or retrieves a configuration setting.
ExtractExtracts the compressed file from the bzip2 archive.
ExtractAllExtracts all files from the compressed archive.
ResetResets the component.
ScanScans the compressed archive.
SetArchiveInputStreamThe stream to read the zip, tar, jar, or gzip archive from.
SetArchiveOutputStreamThe stream to write the zip, tar, jar, or gzip archive to.
SetFileInputStreamThe input stream to read the decompressed data from.

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.

BeginFileFired before a file is processed.
EndFileFired after a file is processed.
ErrorInformation about non-fatal errors.
OverwriteFired whenever a file exists and may be overwritten.
ProgressFired 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.

CloseStreamAfterCompressIf true, the component will close the output stream after compression.
WriteToProgressEventWhether or not to write data to the Progress Event.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks ZIP 2020 .NET Edition - Version 20.0 [Build 7720]