Bzip2 Component

Properties   Methods   Events   Config 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.

Method List

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

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.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

ArchiveFile Property (Bzip2 Component)

The name of the zip, gzip, tar, or jar archive.

Syntax

• C#
• VB.NET

public string ArchiveFile { get; set; }

Public Property ArchiveFile As String

Default Value

""

Remarks

This property specifies the name of the archive to be read or written. This property is required when extracting files.

When Scan, Extract, or ExtractAll is invoked, the file specified by ArchiveFile will be opened for read. If the file does not exist, a trappable error will be generated.

When Compress is called, the file named by ArchiveFile will be written; if a file of this name already exists the Overwrite event will be fired. If ArchiveFile is set to the empty string (""), the archive will not be written to disk, and will be provided only through the Progress event.

The filename may be specified with or without a path. Paths may be relative or absolute, and should be specified in the format native to the host operating system. The filename should be specified with the appropriate extension (such as "zip"); an extension will not automatically be appended by the component.

If the file cannot be read, or written, as appropriate, a trappable error will be generated.

Example (Creating an Archive)

ZipControl.ArchiveFile = "c:\test.zip" ZipControl.RecurseSubdirectories = true ZipControl.IncludeFiles("c:\foo\*") ZipControl.Compress()

Note: an archive already open for read may be closed by setting ArchiveFile to the empty string ("").

Bzip2Data Property (Bzip2 Component)

(Decompression only) The bzip2 file contents as a byte array.

Syntax

• C#
• VB.NET

public string Bzip2Data { set; }
public byte[] Bzip2DataB { set; }

Public WriteOnly Property Bzip2Data As String
Public WriteOnly Property Bzip2DataB As Byte()

Default Value

""

Remarks

Normally you should set ArchiveFile before invoking Scan or Extract. If you prefer to read the bzip2 file from memory you may set Bzip2Data instead. Bzip2Data should be set to the entire contents of the bzip2 file; this will allow you to read from the bzip2 without writing any temporary files to disk.

If you would like to extract data from the archive without ever writing to disk you should also set WriteToProgressEvent to true, and after invoking Scan, you should set the value of FileDecompressedName to an empty string. Then, when you invoke Extract (or ExtractAll) the data will be provided in the Progress event.

This property is write-only. Note that modifying a bzip2 file stored in Bzip2Data is not supported, so Append will throw exceptions.

This property is write-only and not available at design time.

ExtractToPath Property (Bzip2 Component)

A base path to decompress to.

Syntax

• C#
• VB.NET

public string ExtractToPath { get; set; }

Public Property ExtractToPath As String

Default Value

""

Remarks

Setting the ExtractToPath property affects the operation of the Extract and ExtractAll methods. Setting this property to a nonempty string will cause all decompressed files to be written to the specified path. If pathnames are given in the values of FileDecompressedName they will be regarded as relative to ExtractToPath.

If the specified directory does not exist, it will be created when extraction is done.

ExtractToPath should always be specified in the format native to the host operating system, and with a trailing slash or backslash. If the path is specified otherwise, it will be immediately converted and stored in the converted format. For example, "/temp" would be immediately converted to "\temp\" on a Windows system.

FileDecompressedName Property (Bzip2 Component)

File name to decompress to, or compress from.

Syntax

• C#
• VB.NET

public string FileDecompressedName { get; set; }

Public Property FileDecompressedName As String

Default Value

""

Remarks

FileDecompressedName contains the name of the file in the archive, as stored on the file system, outside the archive.

When compressing a file, this property should be specified with a path, if necessary, to allow the file to be found by the component. If the file cannot be found when Compress is called, a trappable error will be generated, and the archive will not be correctly written.

When decompressing files, this property may be set prior to calling Extract. If this property is set to the empty string when Extract is called, Extract will automatically set this property to an appropriate value.

Paths on the local file system should be specified in the format native to the host operating system. They may also be specified in standard (UNIX) format, in which case they will be immediately converted.

FileInputData Property (Bzip2 Component)

The data of the file to be compressed.

Syntax

• C#
• VB.NET

public string FileInputData { get; set; }
public byte[] FileInputDataB { get; set; }

Public Property FileInputData As String
Public Property FileInputDataB As Byte()

Default Value

""

Remarks

When this property is set, the component will read in the data from this property instead of reading from the file contained in the FileDecompressedName property.

This property is not available at design time.

HasMoreData Property (Bzip2 Component)

Shows whether or not there is more data in the bzip2 archive.

Syntax

• C#
• VB.NET

public bool HasMoreData { get; }

Public ReadOnly Property HasMoreData As Boolean

Default Value

False

Remarks

The bzip2 format allows multiple bzip2 data members to be concatenated into a single file. However, due to the nature of the algorithm it is impossible to determine the number of data members until after the entire archive has been decompressed. The HasMoreData property can be used to cycle through the archive and extract each file.

Simply set the ArchiveFile and ExtractToPath properties, then call Extract as long as the component has available data.

Note: the component will not update FileDecompressedName unless you manually set FileDecompressedName on each loop before calling Extract.

Example (Extracting Multiple Files)

ZipControl.ArchiveFile = "c:\temp.bz2" ZipControl.ExtractToPath = "c:\extracted\" Do //here you may set the file name in FileDecompressedName prior to extraction ZipControl.Extract() While ZipControl.HasMoreData

This property is read-only.

Abort Method (Bzip2 Component)

Aborts the current operation.

Syntax

• C#
• VB.NET

public void Abort();

Async Version
public async Task Abort();
public async Task Abort(CancellationToken cancellationToken);

Public Sub Abort()

Async Version
Public Sub Abort() As Task
Public Sub Abort(cancellationToken As CancellationToken) As Task

Remarks

Abort may be used to immediately interrupt compression or decompression. Any files partially written by the component will be deleted.

Append Method (Bzip2 Component)

Adds specified file to an existing archive.

Syntax

• C#
• VB.NET

public void Append();

Async Version
public async Task Append();
public async Task Append(CancellationToken cancellationToken);

Public Sub Append()

Async Version
Public Sub Append() As Task
Public Sub Append(cancellationToken As CancellationToken) As Task

Remarks

The file contained in the FileDecompressedName property will be appended to the archive specified by ArchiveFile.

This method may only be used to add files to an existing archive. To add files to a new archive, Compress method should be used.

Compress Method (Bzip2 Component)

Creates the compressed bzip2 archive.

Syntax

• C#
• VB.NET

public void Compress();

Async Version
public async Task Compress();
public async Task Compress(CancellationToken cancellationToken);

Public Sub Compress()

Async Version
Public Sub Compress() As Task
Public Sub Compress(cancellationToken As CancellationToken) As Task

Remarks

Invoking Compress creates the archive specified by ArchiveFile. When the method is called, the file specified by FileDecompressedName will be opened, and the file specified by ArchiveFile will contain the compressed output.

As the data is compressed the Progress event will be fired at regular intervals. This event may be used to stream out the bzip2 file, or to display a progress bar to the user.

Config Method (Bzip2 Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Extract Method (Bzip2 Component)

Extracts the compressed file from the bzip2 archive.

Syntax

• C#
• VB.NET

public void Extract();

Async Version
public async Task Extract();
public async Task Extract(CancellationToken cancellationToken);

Public Sub Extract()

Async Version
Public Sub Extract() As Task
Public Sub Extract(cancellationToken As CancellationToken) As Task

Remarks

Invoking Extract decompresses the archive specified by ArchiveFile. The compressed file will be extracted, and written to disk.

If FileDecompressedName is set to a nonempty string the file will be written there. Otherwise the component will automatically set FileDecompressedName to an appropriate value:

If ArchiveFile ends in ".bz2", this filename, less the ".bz2" extension will be used.

If this condition does not hold, ".unzipped" will be appended to ArchiveFile.

ExtractAll Method (Bzip2 Component)

Extracts all files from the compressed archive.

Syntax

• C#
• VB.NET

public void ExtractAll();

Async Version
public async Task ExtractAll();
public async Task ExtractAll(CancellationToken cancellationToken);

Public Sub ExtractAll()

Async Version
Public Sub ExtractAll() As Task
Public Sub ExtractAll(cancellationToken As CancellationToken) As Task

Remarks

ExtractAll extracts all files from the archive. The file(s) will be extracted to the directory specified by ExtractToPath, and given the names specified by FileDecompressedName.

The BeginFile and EndFile events will be fired before and after each file is extracted, and the Progress event will be fired as the data is extracted. If WriteToProgressEvent is set to true, the decompressed data will be streamed out through the Progress event.

Reset Method (Bzip2 Component)

Resets the component.

Syntax

• C#
• VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

Reset resets the state of the component. All properties will be set to their default values, and any files open will be closed.

Scan Method (Bzip2 Component)

Scans the compressed archive.

Syntax

• C#
• VB.NET

public void Scan();

Async Version
public async Task Scan();
public async Task Scan(CancellationToken cancellationToken);

Public Sub Scan()

Async Version
Public Sub Scan() As Task
Public Sub Scan(cancellationToken As CancellationToken) As Task

Remarks

This method will scan the bzip archive specified by ArchiveFile. The archive will be read, and the header will be checked.

Unlike in the Zip, Tar, and Jar components, it is never necessary to invoke this method, and it will not be automatically invoked by Extract. Suggested uses for this method would be to check that the file is a bzip file.

SetArchiveInputStream Method (Bzip2 Component)

The stream to read the zip, tar, jar, or gzip archive from.

Syntax

• C#
• VB.NET

public void SetArchiveInputStream(System.IO.Stream archiveStream);

Async Version
public async Task SetArchiveInputStream(System.IO.Stream archiveStream);
public async Task SetArchiveInputStream(System.IO.Stream archiveStream, CancellationToken cancellationToken);

Public Sub SetArchiveInputStream(ByVal ArchiveStream As System.IO.Stream)

Async Version
Public Sub SetArchiveInputStream(ByVal ArchiveStream As System.IO.Stream) As Task
Public Sub SetArchiveInputStream(ByVal ArchiveStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

This method should be set when the archive is to be read from a stream when Extract is called.

By default, and when this is set to null, the component will read from the file specified by ArchiveFile. However, when this is a valid stream, the data will be read from the stream.

SetArchiveOutputStream Method (Bzip2 Component)

The stream to write the zip, tar, jar, or gzip archive to.

Syntax

• C#
• VB.NET

public void SetArchiveOutputStream(System.IO.Stream archiveStream);

Async Version
public async Task SetArchiveOutputStream(System.IO.Stream archiveStream);
public async Task SetArchiveOutputStream(System.IO.Stream archiveStream, CancellationToken cancellationToken);

Public Sub SetArchiveOutputStream(ByVal ArchiveStream As System.IO.Stream)

Async Version
Public Sub SetArchiveOutputStream(ByVal ArchiveStream As System.IO.Stream) As Task
Public Sub SetArchiveOutputStream(ByVal ArchiveStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

This method should be set when the archive is to be written to a stream when Compress is called.

By default, and when this is set to null, the component will write to the file specified by ArchiveFile. However, when this is a valid stream, the data will be written to the stream.

SetFileInputStream Method (Bzip2 Component)

The input stream to read the decompressed data from.

Syntax

• C#
• VB.NET

public void SetFileInputStream(System.IO.Stream archiveStream);

Async Version
public async Task SetFileInputStream(System.IO.Stream archiveStream);
public async Task SetFileInputStream(System.IO.Stream archiveStream, CancellationToken cancellationToken);

Public Sub SetFileInputStream(ByVal ArchiveStream As System.IO.Stream)

Async Version
Public Sub SetFileInputStream(ByVal ArchiveStream As System.IO.Stream) As Task
Public Sub SetFileInputStream(ByVal ArchiveStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

When this method is set to a valid stream, the component will read in the data from the stream as the current file instead of reading from the file contained in the FileDecompressedName property.

BeginFile Event (Bzip2 Component)

Fired before a file is processed.

Syntax

• C#
• VB.NET

public event OnBeginFileHandler OnBeginFile;

public delegate void OnBeginFileHandler(object sender, Bzip2BeginFileEventArgs e);

public class Bzip2BeginFileEventArgs : EventArgs {
  public int Index { get; }
  public bool Skip { get; set; }
}

Public Event OnBeginFile As OnBeginFileHandler

Public Delegate Sub OnBeginFileHandler(sender As Object, e As Bzip2BeginFileEventArgs)

Public Class Bzip2BeginFileEventArgs Inherits EventArgs
  Public ReadOnly Property Index As Integer
  Public Property Skip As Boolean
End Class

Remarks

BeginFile is fired before compression or decompression begins. Index will contain 0.

You may use the Skip parameter to tell the component to skip the file when appending or decompressing.

EndFile Event (Bzip2 Component)

Fired after a file is processed.

Syntax

• C#
• VB.NET

public event OnEndFileHandler OnEndFile;

public delegate void OnEndFileHandler(object sender, Bzip2EndFileEventArgs e);

public class Bzip2EndFileEventArgs : EventArgs {
  public int Index { get; }
}

Public Event OnEndFile As OnEndFileHandler

Public Delegate Sub OnEndFileHandler(sender As Object, e As Bzip2EndFileEventArgs)

Public Class Bzip2EndFileEventArgs Inherits EventArgs
  Public ReadOnly Property Index As Integer
End Class

Remarks

EndFile is fired when compression or decompression finishes. Index will contain 0.

Error Event (Bzip2 Component)

Information about non-fatal errors.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, Bzip2ErrorEventArgs e);

public class Bzip2ErrorEventArgs : EventArgs {
  public string Description { get; }
  public int ErrorCode { get; }
  public int Index { get; }
  public string Filename { get; }
  public bool Ignore { get; set; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As Bzip2ErrorEventArgs)

Public Class Bzip2ErrorEventArgs Inherits EventArgs
  Public ReadOnly Property Description As String
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Index As Integer
  Public ReadOnly Property Filename As String
  Public Property Ignore As Boolean
End Class

Remarks

The Error event is fired when non-fatal errors occur during compression or decompression. Note that if this event is fired during decompression this may indicate that the archive is corrupt.

By default these errors will cause the component to fail with an exception. The exception may be overridden by setting Ignore to true. This will cause the error to be ignored, the file will be skipped if necessary, and the component will continue operation.

ErrorCode will correspond to one of the following errors:

Description contains a textual description of the error. Index and Filename contain the array index (where appropriate) and filename of the file being processed at the time of the error.

Overwrite Event (Bzip2 Component)

Fired whenever a file exists and may be overwritten.

Syntax

• C#
• VB.NET

public event OnOverwriteHandler OnOverwrite;

public delegate void OnOverwriteHandler(object sender, Bzip2OverwriteEventArgs e);

public class Bzip2OverwriteEventArgs : EventArgs {
  public string Filename { get; set; }
  public bool Overwrite { get; set; }
}

Public Event OnOverwrite As OnOverwriteHandler

Public Delegate Sub OnOverwriteHandler(sender As Object, e As Bzip2OverwriteEventArgs)

Public Class Bzip2OverwriteEventArgs Inherits EventArgs
  Public Property Filename As String
  Public Property Overwrite As Boolean
End Class

Remarks

Overwrite is fired when a file is about to be overwritten, and would overwrite an existing file. The event is fired during decompression.

Filename contains the full name of the file, specified with its pathname.

Overwrite specifies whether or not the file will be overwritten. For Zip, Jar, and Tar, this is equal by default to the value of the OverwriteFiles property. For Gzip, this value defaults to true.

Either of the parameters may be changed when the event is fired. Changing the value of Overwrite will override the default behavior of the component, and cause the file to be overwritten or not overwritten, depending on the value set. If Filename is changed, the value of Overwrite will be ignored, and the file will be written with the specified name. If a file of the new name also exists this file will be silently overwritten.

Progress Event (Bzip2 Component)

Fired as progress is made.

Syntax

• C#
• VB.NET

public event OnProgressHandler OnProgress;

public delegate void OnProgressHandler(object sender, Bzip2ProgressEventArgs e);

public class Bzip2ProgressEventArgs : EventArgs {
  public string Data { get; }
  public byte[] DataB { get; }
  public string Filename { get; }
  public long BytesProcessed { get; }
  public int PercentProcessed { get; }
}

Public Event OnProgress As OnProgressHandler

Public Delegate Sub OnProgressHandler(sender As Object, e As Bzip2ProgressEventArgs)

Public Class Bzip2ProgressEventArgs Inherits EventArgs
  Public ReadOnly Property Data As String
  Public ReadOnly Property DataB As Byte()
  Public ReadOnly Property Filename As String
  Public ReadOnly Property BytesProcessed As Long
  Public ReadOnly Property PercentProcessed As Integer
End Class

Remarks

The Progress event is automatically fired as compression or decompression is performed. When WriteToProgressEvent is true, the output data is provided through the Data parameter, allowing for it to be streamed out.

Filename contains the name of the file being written. If no file is being written, Filename will contain an empty string, and the output data will be provided exclusively through this event.

BytesProcessed contains the total number of uncompressed bytes processed. PercentProcessed contains the percent of uncompressed bytes processed, corresponding roughly to the running time of the operation.

For Gzip extraction only, BytesProcessed and PercentProcessed will reflect the number of compressed bytes extracted, as it is generally impossible to predetermine the total uncompressed size.

If WriteToProgressEvent is false, Data will contain null.

Config Settings (Bzip2 Component)

Bzip2 Config Settings

Base Config Settings

Trappable Errors (Bzip2 Component)

The following errors may be generated by the component. Note that frequently the error message will contain more specific information than what is listed here.

Note that some non-fatal errors may be trapped and explicitly ignored in the Error event. This will allow the component to continue operation even in case of error.

Bzip2 Errors