# Struct ipworkszip::Bzip2

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

## Syntax

```text
ipworkszip::Bzip2
```

## Remarks

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

To compress with the struct, set [archive_file](#archive_file-property-bzip2-struct) to the name of the bzip2 file to be created, and [file_decompressed_name](#file_decompressed_name-property-bzip2-struct) to the name of the file to be compressed. Finally, invoke [compress](#compress-method-bzip2-struct). To extract the file, set [archive_file](#archive_file-property-bzip2-struct) to the bzip2 archive and [file_decompressed_name](#file_decompressed_name-property-bzip2-struct) to the file where the struct should extract. Finally, invoke the [extract](#extract-method-bzip2-struct) or [compress](#compress-method-bzip2-struct) method.

**Example (Creating a Bzip2 File)**

```text
ZipControl.ArchiveFile = "c:\test.bz2"
ZipControl.FileDecompressedName = "c:\test.txt"
ZipControl.Compress()
```

 **Example (Extracting from a Bzip2 File)**

```text
ZipControl.ArchiveFile = "c:\test.bz2"
ZipControl.FileDecompressedName = "c:\test.txt"
ZipControl.Extract()
```

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

### Object Lifetime

 The *new()* method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksZip. Due to this, the Bzip2 struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of Bzip2 when you have finished using the instance.

## Property List

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

|  |  |
| --- | --- |
| [archive_file](#archive_file-property-bzip2-struct) | The name of the zip, gzip, tar, or jar archive. |
| [bzip2_data](#bzip2_data-property-bzip2-struct) | (Decompression only) The bzip2 file contents as a byte array. |
| [extract_to_path](#extract_to_path-property-bzip2-struct) | A base path to decompress to. |
| [file_decompressed_name](#file_decompressed_name-property-bzip2-struct) | File name to decompress to, or compress from. |
| [file_input_data](#file_input_data-property-bzip2-struct) | The data of the file to be compressed. |
| [has_more_data](#has_more_data-property-bzip2-struct) | 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 struct with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [abort](#abort-method-bzip2-struct) | Aborts the current operation. |
| [append](#append-method-bzip2-struct) | Adds specified file to an existing archive. |
| [compress](#compress-method-bzip2-struct) | Creates the compressed bzip2 archive. |
| [config](#config-method-bzip2-struct) | Sets or retrieves a configuration setting. |
| [extract](#extract-method-bzip2-struct) | Extracts the compressed file from the bzip2 archive. |
| [extract_all](#extract_all-method-bzip2-struct) | Extracts all files from the compressed archive. |
| [reset](#reset-method-bzip2-struct) | Resets the struct. |
| [scan](#scan-method-bzip2-struct) | Scans the compressed archive. |

## Event List

*The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [on_begin_file](#on_begin_file-event-bzip2-struct) | Fired before a file is processed. |
| [on_end_file](#on_end_file-event-bzip2-struct) | Fired after a file is processed. |
| [on_error](#on_error-event-bzip2-struct) | Information about non-fatal errors. |
| [on_overwrite](#on_overwrite-event-bzip2-struct) | Fired whenever a file exists and may be overwritten. |
| [on_progress](#on_progress-event-bzip2-struct) | Fired as progress is made. |

## Config Settings

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

|  |  |
| --- | --- |
| [WriteToProgressEvent](#WriteToProgressEvent) | Whether or not to write data to the Progress Event. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# archive_file property ([Bzip2](#struct-ipworkszipbzip2) Struct)

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

## Syntax

*Rust Syntax*

```text
fn archive_file(&self ) -> Result<String, IPWorksZipError> fn set_archive_file(&self, value : &str) ->  Option<IPWorksZipError>
fn set_archive_file_ref(&self, value : &String) ->  Option<IPWorksZipError>
```

## 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](#scan-method-bzip2-struct), [extract](#extract-method-bzip2-struct), or [extract_all](#extract_all-method-bzip2-struct) is invoked, the file specified by archive_file will be opened for read. If the file does not exist, a trappable error will be generated.

When [compress](#compress-method-bzip2-struct) is called, the file named by archive_file will be written; if a file of this name already exists the [on_overwrite](#on_overwrite-event-bzip2-struct) event will be fired. If archive_file is set to the empty string (""), the archive will not be written to disk, and will be provided only through the [on_progress](#on_progress-event-bzip2-struct) 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 struct.

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

**Example (Creating an Archive)**

```text
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 archive_file to the empty string ("").

## Data Type

String

# bzip2_data property ([Bzip2](#struct-ipworkszipbzip2) Struct)

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

## Syntax

*Rust Syntax*

```text
fn set_bzip2_data(&self, value : Vec<u8>) ->  Option<IPWorksZipError>
fn set_bzip2_data_ref(&self, value : &[u8]) ->  Option<IPWorksZipError>
```

## Default Value

""

## Remarks

Normally you should set [archive_file](#archive_file-property-bzip2-struct) before invoking [scan](#scan-method-bzip2-struct) or [extract](#extract-method-bzip2-struct). If you prefer to read the bzip2 file from memory you may set bzip2_data instead. bzip2_data 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](#WriteToProgressEvent) to true, and after invoking [scan](#scan-method-bzip2-struct), you should set the value of [file_decompressed_name](#file_decompressed_name-property-bzip2-struct) to an empty string. Then, when you invoke [extract](#extract-method-bzip2-struct) (or [extract_all](#extract_all-method-bzip2-struct)) the data will be provided in the [on_progress](#on_progress-event-bzip2-struct) event.

This property is write-only. Note that modifying a bzip2 file stored in bzip2_data is not supported, so [append](#append-method-bzip2-struct) will throw exceptions.

This property is write-only.

## Data Type

Vec

# extract_to_path property ([Bzip2](#struct-ipworkszipbzip2) Struct)

A base path to decompress to.

## Syntax

*Rust Syntax*

```text
fn extract_to_path(&self ) -> Result<String, IPWorksZipError> fn set_extract_to_path(&self, value : &str) ->  Option<IPWorksZipError>
fn set_extract_to_path_ref(&self, value : &String) ->  Option<IPWorksZipError>
```

## Default Value

""

## Remarks

Setting the extract_to_path property affects the operation of the [extract](#extract-method-bzip2-struct) and [extract_all](#extract_all-method-bzip2-struct) 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 [file_decompressed_name](#file_decompressed_name-property-bzip2-struct) they will be regarded as relative to extract_to_path.

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

extract_to_path 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.

## Data Type

String

# file_decompressed_name property ([Bzip2](#struct-ipworkszipbzip2) Struct)

File name to decompress to, or compress from.

## Syntax

*Rust Syntax*

```text
fn file_decompressed_name(&self ) -> Result<String, IPWorksZipError> fn set_file_decompressed_name(&self, value : &str) ->  Option<IPWorksZipError>
fn set_file_decompressed_name_ref(&self, value : &String) ->  Option<IPWorksZipError>
```

## Default Value

""

## Remarks

file_decompressed_name 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 struct. If the file cannot be found when [compress](#compress-method-bzip2-struct) 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](#extract-method-bzip2-struct). If this property is set to the empty string when [extract](#extract-method-bzip2-struct) is called, [extract](#extract-method-bzip2-struct) 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.

## Data Type

String

# file_input_data property ([Bzip2](#struct-ipworkszipbzip2) Struct)

The data of the file to be compressed.

## Syntax

*Rust Syntax*

```text
fn file_input_data(&self ) -> Result<Vec<u8>, IPWorksZipError> fn set_file_input_data(&self, value : Vec<u8>) ->  Option<IPWorksZipError>
fn set_file_input_data_ref(&self, value : &[u8]) ->  Option<IPWorksZipError>
```

## Default Value

""

## Remarks

When this property is set, the struct will read in the data from this property instead of reading from the file contained in the [file_decompressed_name](#file_decompressed_name-property-bzip2-struct) property.

## Data Type

Vec

# has_more_data property ([Bzip2](#struct-ipworkszipbzip2) Struct)

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

## Syntax

*Rust Syntax*

```text
fn has_more_data(&self ) -> Result<bool, IPWorksZipError>
```

## 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 has_more_data property can be used to cycle through the archive and extract each file.

Simply set the [archive_file](#archive_file-property-bzip2-struct) and [extract_to_path](#extract_to_path-property-bzip2-struct) properties, then call [extract](#extract-method-bzip2-struct) as long as the struct has available data.

**Note**: the struct will not update [file_decompressed_name](#file_decompressed_name-property-bzip2-struct) unless you manually set [file_decompressed_name](#file_decompressed_name-property-bzip2-struct) on each loop before calling [extract](#extract-method-bzip2-struct).

**Example (Extracting Multiple Files)**

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

This property is read-only.

## Data Type

bool

# abort method ([Bzip2](#struct-ipworkszipbzip2) Struct)

Aborts the current operation.

## Syntax

*Rust Syntax*

```text
fn abort(&self) -> Result<(), IPWorksZipError>
```

## Remarks

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

# append method ([Bzip2](#struct-ipworkszipbzip2) Struct)

Adds specified file to an existing archive.

## Syntax

*Rust Syntax*

```text
fn append(&self) -> Result<(), IPWorksZipError>
```

## Remarks

The file contained in the [file_decompressed_name](#file_decompressed_name-property-bzip2-struct) property will be appended to the archive specified by [archive_file](#archive_file-property-bzip2-struct).

This method may only be used to add files to an existing archive. To add files to a new archive, [compress](#compress-method-bzip2-struct) method should be used.

# compress method ([Bzip2](#struct-ipworkszipbzip2) Struct)

Creates the compressed bzip2 archive.

## Syntax

*Rust Syntax*

```text
fn compress(&self) -> Result<(), IPWorksZipError>
```

## Remarks

Invoking compress creates the archive specified by [archive_file](#archive_file-property-bzip2-struct). When the method is called, the file specified by [file_decompressed_name](#file_decompressed_name-property-bzip2-struct) will be opened, and the file specified by [archive_file](#archive_file-property-bzip2-struct) will contain the compressed output.

As the data is compressed the [on_progress](#on_progress-event-bzip2-struct) 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](#struct-ipworkszipbzip2) Struct)

Sets or retrieves a configuration setting.

## Syntax

*Rust Syntax*

```text
fn config(&self, configuration_string : &str) ->  Result<String, IPWorksZipError>
```

## Remarks

config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-bzip2-struct) for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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](#config-settings-bzip2-struct), you must call *Config("PROPERTY")*. The value will be returned as a string.

# extract method ([Bzip2](#struct-ipworkszipbzip2) Struct)

Extracts the compressed file from the bzip2 archive.

## Syntax

*Rust Syntax*

```text
fn extract(&self) -> Result<(), IPWorksZipError>
```

## Remarks

Invoking extract decompresses the archive specified by [archive_file](#archive_file-property-bzip2-struct). The compressed file will be extracted, and written to disk.

If [file_decompressed_name](#file_decompressed_name-property-bzip2-struct) is set to a nonempty string the file will be written there. Otherwise the struct will automatically set [file_decompressed_name](#file_decompressed_name-property-bzip2-struct) to an appropriate value:

If [archive_file](#archive_file-property-bzip2-struct) ends in ".bz2", this filename, less the ".bz2" extension will be used.

If this condition does not hold, ".unzipped" will be appended to [archive_file](#archive_file-property-bzip2-struct).

# extract_all method ([Bzip2](#struct-ipworkszipbzip2) Struct)

Extracts all files from the compressed archive.

## Syntax

*Rust Syntax*

```text
fn extract_all(&self) -> Result<(), IPWorksZipError>
```

## Remarks

extract_all extracts all files from the archive. The file(s) will be extracted to the directory specified by [extract_to_path](#extract_to_path-property-bzip2-struct), and given the names specified by [file_decompressed_name](#file_decompressed_name-property-bzip2-struct).

The [on_begin_file](#on_begin_file-event-bzip2-struct) and [on_end_file](#on_end_file-event-bzip2-struct) events will be fired before and after each file is extracted, and the [on_progress](#on_progress-event-bzip2-struct) event will be fired as the data is extracted. If [WriteToProgressEvent](#WriteToProgressEvent) is set to true, the decompressed data will be streamed out through the [on_progress](#on_progress-event-bzip2-struct) event.

# reset method ([Bzip2](#struct-ipworkszipbzip2) Struct)

Resets the struct.

## Syntax

*Rust Syntax*

```text
fn reset(&self) -> Result<(), IPWorksZipError>
```

## Remarks

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

# scan method ([Bzip2](#struct-ipworkszipbzip2) Struct)

Scans the compressed archive.

## Syntax

*Rust Syntax*

```text
fn scan(&self) -> Result<(), IPWorksZipError>
```

## Remarks

This method will scan the bzip archive specified by [archive_file](#archive_file-property-bzip2-struct). The archive will be read, and the header will be checked.

Unlike in the **Zip**, **Tar**, and **Jar** structs, it is never necessary to invoke this method, and it will not be automatically invoked by [extract](#extract-method-bzip2-struct). Suggested uses for this method would be to check that the file is a bzip file.

# on_begin_file event ([Bzip2](#struct-ipworkszipbzip2) Struct)

Fired before a file is processed.

## Syntax

*Rust Syntax*

```text
// Bzip2BeginFileEventArgs carries the Bzip2 BeginFile event's parameters.
pub struct Bzip2BeginFileEventArgs {
  fn index(&self) -> i32
  fn skip(&self) -> bool
  fn set_skip(&self, value : bool)
}

// Bzip2BeginFileEvent defines the signature of the Bzip2 BeginFile event's handler function.
pub trait Bzip2BeginFileEvent {
  fn on_begin_file(&self, sender : Bzip2, e : &mut Bzip2BeginFileEventArgs);
}

impl <'a> Bzip2<'a> {
  pub fn on_begin_file(&self) -> &'a dyn Bzip2BeginFileEvent;
  pub fn set_on_begin_file(&mut self, value : &'a dyn Bzip2BeginFileEvent);
  ...
}
```

## Remarks

on_begin_file is fired before compression or decompression begins. *index* will contain 0.

You may use the *skip* parameter to tell the struct to skip the file when appending or decompressing.

# on_end_file event ([Bzip2](#struct-ipworkszipbzip2) Struct)

Fired after a file is processed.

## Syntax

*Rust Syntax*

```text
// Bzip2EndFileEventArgs carries the Bzip2 EndFile event's parameters.
pub struct Bzip2EndFileEventArgs {
  fn index(&self) -> i32
}

// Bzip2EndFileEvent defines the signature of the Bzip2 EndFile event's handler function.
pub trait Bzip2EndFileEvent {
  fn on_end_file(&self, sender : Bzip2, e : &mut Bzip2EndFileEventArgs);
}

impl <'a> Bzip2<'a> {
  pub fn on_end_file(&self) -> &'a dyn Bzip2EndFileEvent;
  pub fn set_on_end_file(&mut self, value : &'a dyn Bzip2EndFileEvent);
  ...
}
```

## Remarks

on_end_file is fired when compression or decompression finishes. *index* will contain 0.

# on_error event ([Bzip2](#struct-ipworkszipbzip2) Struct)

Information about non-fatal errors.

## Syntax

*Rust Syntax*

```text
// Bzip2ErrorEventArgs carries the Bzip2 Error event's parameters.
pub struct Bzip2ErrorEventArgs {
  fn description(&self) -> &String
  fn error_code(&self) -> i32
  fn index(&self) -> i32
  fn file_name(&self) -> &String
  fn ignore(&self) -> bool
  fn set_ignore(&self, value : bool)
}

// Bzip2ErrorEvent defines the signature of the Bzip2 Error event's handler function.
pub trait Bzip2ErrorEvent {
  fn on_error(&self, sender : Bzip2, e : &mut Bzip2ErrorEventArgs);
}

impl <'a> Bzip2<'a> {
  pub fn on_error(&self) -> &'a dyn Bzip2ErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn Bzip2ErrorEvent);
  ...
}
```

## Remarks

The on_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 struct will continue operation.

*error_code* will correspond to one of the following errors:

|  |  |
| --- | --- |
| 1 | Bad or missing CRC-32 checksum. |
| 2 | Failed to set creation date of a file. |
| 111 | Can't open file for read (skipping). |

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

# on_overwrite event ([Bzip2](#struct-ipworkszipbzip2) Struct)

Fired whenever a file exists and may be overwritten.

## Syntax

*Rust Syntax*

```text
// Bzip2OverwriteEventArgs carries the Bzip2 Overwrite event's parameters.
pub struct Bzip2OverwriteEventArgs {
  fn file_name(&self) -> &String
  fn set_file_name(&self, value : &str)
  fn set_file_name_ref(&self, value : &String)
  fn overwrite(&self) -> bool
  fn set_overwrite(&self, value : bool)
}

// Bzip2OverwriteEvent defines the signature of the Bzip2 Overwrite event's handler function.
pub trait Bzip2OverwriteEvent {
  fn on_overwrite(&self, sender : Bzip2, e : &mut Bzip2OverwriteEventArgs);
}

impl <'a> Bzip2<'a> {
  pub fn on_overwrite(&self) -> &'a dyn Bzip2OverwriteEvent;
  pub fn set_on_overwrite(&mut self, value : &'a dyn Bzip2OverwriteEvent);
  ...
}
```

## Remarks

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

*file_name* 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 overwrite_files 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 struct, and cause the file to be overwritten or not overwritten, depending on the value set. If *file_name* 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.

# on_progress event ([Bzip2](#struct-ipworkszipbzip2) Struct)

Fired as progress is made.

## Syntax

*Rust Syntax*

```text
// Bzip2ProgressEventArgs carries the Bzip2 Progress event's parameters.
pub struct Bzip2ProgressEventArgs {
  fn data(&self) -> &[u8]
  fn file_name(&self) -> &String
  fn bytes_processed(&self) -> i64
  fn percent_processed(&self) -> i32
}

// Bzip2ProgressEvent defines the signature of the Bzip2 Progress event's handler function.
pub trait Bzip2ProgressEvent {
  fn on_progress(&self, sender : Bzip2, e : &mut Bzip2ProgressEventArgs);
}

impl <'a> Bzip2<'a> {
  pub fn on_progress(&self) -> &'a dyn Bzip2ProgressEvent;
  pub fn set_on_progress(&mut self, value : &'a dyn Bzip2ProgressEvent);
  ...
}
```

## Remarks

The on_progress event is automatically fired as compression or decompression is performed. When [WriteToProgressEvent](#WriteToProgressEvent) is true, the output data is provided through the *data* parameter, allowing for it to be streamed out.

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

*bytes_processed* contains the total number of uncompressed bytes processed. *percent_processed* contains the percent of uncompressed bytes processed, corresponding roughly to the running time of the operation.

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

If [WriteToProgressEvent](#WriteToProgressEvent) is false, *data* will contain null.

# Config Settings ([Bzip2](#struct-ipworkszipbzip2) Struct)

 The struct accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these *internal properties* is provided through the [config](#config-method-bzip2-struct) method.

### Bzip2 Config Settings

**WriteToProgressEvent**: Whether or not to write data to the Progress Event.If [WriteToProgressEvent](#WriteToProgressEvent) is set to true, then all data produced through invocations of [extract](#extract-method-bzip2-struct), [extract_all](#extract_all-method-bzip2-struct), and [compress](#compress-method-bzip2-struct) will be written to the [on_progress](#on_progress-event-bzip2-struct) event as well as to disk. Applications may stream out the compressed or decompressed data by trapping this event and copying the data.

If [WriteToProgressEvent](#WriteToProgressEvent) is set to false, the data will not be streamed out, and the *Data* parameter of the [on_progress](#on_progress-event-bzip2-struct) event will contain null.

By default, this config is set to false.

### Base Config Settings

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a struct is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the struct will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the struct to use the internal implementation instead of using the system security libraries.

 On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default.

 To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section.

# Trappable Errors ([Bzip2](#struct-ipworkszipbzip2) Struct)

 **Errors**

The following errors may be generated by the struct. 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 [on_error](#on_error-event-bzip2-struct) event. This will allow the struct to continue operation even in case of error.

### Bzip2 Errors

|  |  |
| --- | --- |
| 111 | Can't open file for read. |
| 112 | Can't open file for write. |
| 113 | Can't create directory. |
| 114 | The file is too large. |
| 115 | Can't create empty archive. |
| 116 | The archive must be scanned prior to attempting this operation. |
| 117 | The array index is out of range. |
| 118 | The maximum size of the archive has been exceeded. |
| 119 | The archive must be specified, or streaming must be enabled. |
| 120 | The component is busy. |
| 124 | Must specify the compressed name. |
| 127 | Bad CRC-32 checksum. |
| 128 | Unable to set file date. |
| 133 | File already exists in the archive. |
| 150 | An I/O error has occurred (details follow). |