# ZCompress Component

The ZCompress component implements an LZC compressor and decompressor. It is compatible with the UNIX compress utility.

## Syntax

```text
nsoftware.IPWorksZip.ZCompress
```

## Remarks

The LZC file format is 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](#archivefile-property-zcompress-component) to the name of the LZC compressed file to be created, and [FileDecompressedName](#filedecompressedname-property-zcompress-component) to the name of the file to be compressed. Finally, invoke [Compress](#compress-method-zcompress-component). To extract the file, first set [ArchiveFile](#archivefile-property-zcompress-component). [FileDecompressedName](#filedecompressedname-property-zcompress-component) may then be set; if not, it will automatically be set based on the [ArchiveFile](#archivefile-property-zcompress-component) name. Finally, invoke the [Extract](#extract-method-zcompress-component) method.

**Example (Creating an LZC File)**

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

 **Example (Extracting from an LZC File)**

```text
ZipControl.ArchiveFile = "c:\test.Z"
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.*

|  |  |
| --- | --- |
| [ArchiveFile](#archivefile-property-zcompress-component) | The name of the zip, gzip, tar, or jar archive. |
| [FileDecompressedName](#filedecompressedname-property-zcompress-component) | File name to decompress to, or compress from. |
| [FileInputData](#fileinputdata-property-zcompress-component) | The data of the file to be compressed. |
| [ZCompressData](#zcompressdata-property-zcompress-component) | (Decompression only) The LZC compressed file contents as a byte array. |

## Method List

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

|  |  |
| --- | --- |
| [Abort](#abort-method-zcompress-component) | Aborts the current operation. |
| [Compress](#compress-method-zcompress-component) | Creates the compressed archive. |
| [Config](#config-method-zcompress-component) | Sets or retrieves a configuration setting. |
| [Extract](#extract-method-zcompress-component) | Extracts the compressed file from the archive. |
| [Reset](#reset-method-zcompress-component) | Resets the component. |
| [SetArchiveInputStream](#setarchiveinputstream-method-zcompress-component) | The stream to read the zip, tar, jar, or gzip archive from. |
| [SetArchiveOutputStream](#setarchiveoutputstream-method-zcompress-component) | The stream to write the zip, tar, jar, or gzip archive to. |
| [SetFileInputStream](#setfileinputstream-method-zcompress-component) | The 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.*

|  |  |
| --- | --- |
| [BeginFile](#beginfile-event-zcompress-component) | Fired before a file is processed. |
| [EndFile](#endfile-event-zcompress-component) | Fired after a file is processed. |
| [Error](#error-event-zcompress-component) | Information about non-fatal errors. |
| [Overwrite](#overwrite-event-zcompress-component) | Fired whenever a file exists and may be overwritten. |
| [Progress](#progress-event-zcompress-component) | Fired as progress is made. |

## Config Settings

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

|  |  |
| --- | --- |
| [CloseStreamAfterCompress](#CloseStreamAfterCompress) | If true, the component will close the output stream after compression. |
| [WriteToProgressEvent](#WriteToProgressEvent) | Whether or not to write data to the Progress Event. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [GUIAvailable](#GUIAvailable) | Whether or not a message loop is available for processing events. |
| [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. |

# ArchiveFile Property ([ZCompress](#zcompress-component) Component)

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

## Syntax

```text
public string ArchiveFile { get; set; }
```

## 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](#extract-method-zcompress-component), 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](#compress-method-zcompress-component) is called, the file named by ArchiveFile will be written; if a file of this name already exists the [Overwrite](#overwrite-event-zcompress-component) 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](#progress-event-zcompress-component) 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)**

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

# FileDecompressedName Property ([ZCompress](#zcompress-component) Component)

File name to decompress to, or compress from.

## Syntax

```text
public string FileDecompressedName { get; set; }
```

## 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 and [SetFileInputStream](#setfileinputstream-method-zcompress-component) has not been called with a valid input stream, 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](#compress-method-zcompress-component) 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-zcompress-component). If this property is set to the empty string when [Extract](#extract-method-zcompress-component) is called, [Extract](#extract-method-zcompress-component) 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 ([ZCompress](#zcompress-component) Component)

The data of the file to be compressed.

## Syntax

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

## 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](#filedecompressedname-property-zcompress-component) property.

This property is not available at design time.

# ZCompressData Property ([ZCompress](#zcompress-component) Component)

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

## Syntax

```text
public string ZCompressData { set; }
public byte[] ZCompressDataB { set; }
```

## Default Value

""

## Remarks

Normally you should set [ArchiveFile](#archivefile-property-zcompress-component) before invoking [Extract](#extract-method-zcompress-component). If you prefer to read the LZC compressed file from memory you may set ZCompressData instead. ZCompressData should be set to the entire contents of the LZC compressed file; this will allow you to read from the archive 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 you should set the value of [FileDecompressedName](#filedecompressedname-property-zcompress-component) to an empty string. Then, when you invoke [Extract](#extract-method-zcompress-component) the data will be provided in the [Progress](#progress-event-zcompress-component) event.

This property is write-only. Note that modifying a LZC compressed file stored in ZCompressData is not supported.

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

# Abort Method ([ZCompress](#zcompress-component) Component)

Aborts the current operation.

## Syntax

```text
public void Abort();

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

## Remarks

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

# Compress Method ([ZCompress](#zcompress-component) Component)

Creates the compressed archive.

## Syntax

```text
public void Compress();

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

## Remarks

Invoking Compress creates the archive specified by [ArchiveFile](#archivefile-property-zcompress-component). When the method is called, the file specified by [FileDecompressedName](#filedecompressedname-property-zcompress-component) will be opened, and the file specified by [ArchiveFile](#archivefile-property-zcompress-component) will contain the compressed output.

# Config Method ([ZCompress](#zcompress-component) Component)

Sets or retrieves a configuration setting.

## Syntax

```text
public string Config(string configurationString);

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

## Remarks

Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-zcompress-component) 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](#config-settings-zcompress-component), you must call *Config("PROPERTY")*. The value will be returned as a string.

# Extract Method ([ZCompress](#zcompress-component) Component)

Extracts the compressed file from the archive.

## Syntax

```text
public void Extract();

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

## Remarks

Invoking Extract decompresses the archive specified by [ArchiveFile](#archivefile-property-zcompress-component). The compressed file will be extracted, and written to disk.

If [FileDecompressedName](#filedecompressedname-property-zcompress-component) is set to a nonempty string the file will be written there. Otherwise the component will automatically set [FileDecompressedName](#filedecompressedname-property-zcompress-component) to an appropriate value:

If [FileDecompressedName](#filedecompressedname-property-zcompress-component) is empty and [ArchiveFile](#archivefile-property-zcompress-component) ends in ".Z", this filename, less the ".Z" extension will be used. Otherwise the extension ".uncompressed" will be appended to the file name.

# Reset Method ([ZCompress](#zcompress-component) Component)

Resets the component.

## Syntax

```text
public void Reset();

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

## Remarks

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

# SetArchiveInputStream Method ([ZCompress](#zcompress-component) Component)

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

## Syntax

```text
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);
```

## Remarks

This method should be set when the archive is to be read from a stream when [Extract](#extract-method-zcompress-component) is called.

By default, and when this is set to null, the component will read from the file specified by [ArchiveFile](#archivefile-property-zcompress-component). However, when this is a valid stream, the data will be read from the stream.

# SetArchiveOutputStream Method ([ZCompress](#zcompress-component) Component)

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

## Syntax

```text
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);
```

## Remarks

This method should be set when the archive is to be written to a stream when [Compress](#compress-method-zcompress-component) is called.

By default, and when this is set to null, the component will write to the file specified by [ArchiveFile](#archivefile-property-zcompress-component). However, when this is a valid stream, the data will be written to the stream.

# SetFileInputStream Method ([ZCompress](#zcompress-component) Component)

The input stream to read the decompressed data from.

## Syntax

```text
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);
```

## 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](#filedecompressedname-property-zcompress-component) property.

# BeginFile Event ([ZCompress](#zcompress-component) Component)

Fired before a file is processed.

## Syntax

```text
public event OnBeginFileHandler OnBeginFile;

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

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

## 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 compressing or decompressing.

# EndFile Event ([ZCompress](#zcompress-component) Component)

Fired after a file is processed.

## Syntax

```text
public event OnEndFileHandler OnEndFile;

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

public class ZCompressEndFileEventArgs : EventArgs {
  public int Index { get; }
}
```

## Remarks

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

# Error Event ([ZCompress](#zcompress-component) Component)

Information about non-fatal errors.

## Syntax

```text
public event OnErrorHandler OnError;

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

public class ZCompressErrorEventArgs : EventArgs {
  public string Description { get; }
  public int ErrorCode { get; }
  public int Index { get; }
  public string FileName { get; }
  public bool Ignore { get; set; }
}
```

## 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:

|  |  |
| --- | --- |
| 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 *FileName* contain the array index (where appropriate) and filename of the file being processed at the time of the error.

# Overwrite Event ([ZCompress](#zcompress-component) Component)

Fired whenever a file exists and may be overwritten.

## Syntax

```text
public event OnOverwriteHandler OnOverwrite;

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

public class ZCompressOverwriteEventArgs : EventArgs {
  public string FileName { get; set; }
  public bool Overwrite { get; set; }
}
```

## 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 ([ZCompress](#zcompress-component) Component)

Fired as progress is made.

## Syntax

```text
public event OnProgressHandler OnProgress;

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

public class ZCompressProgressEventArgs : EventArgs {
  public string Data { get; }  public byte[] DataB { get; }
  public string FileName { get; }
  public long BytesProcessed { get; }
  public int PercentProcessed { get; }
}
```

## Remarks

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

*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](#WriteToProgressEvent) is false, *Data* will contain null.

# Config Settings ([ZCompress](#zcompress-component) Component)

 The component 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 component, access to these *internal properties* is provided through the [Config](#config-method-zcompress-component) method.

### ZCompress Config Settings

**CloseStreamAfterCompress**: If true, the component will close the output stream after compression.This property is true by default. Therefore, by default, the output stream will be closed after compression is completed. In order to keep streams open after the compression completes, you must set this config to false.

**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-zcompress-component), ExtractAll, and [Compress](#compress-method-zcompress-component) will be written to the [Progress](#progress-event-zcompress-component) 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 [Progress](#progress-event-zcompress-component) 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.

**GUIAvailable**: Whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting [GUIAvailable](#GUIAvailable) to *false* will ensure that the component does not attempt to process external events.

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a component 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 component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to *true*.

Setting this configuration setting to *true* tells the component 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.

NOTE: This setting is static. The value set is applicable to all components used in the application.

When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.

# Trappable Errors ([ZCompress](#zcompress-component) Component)

 **Errors**

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](#error-event-zcompress-component) event. This will allow the component to continue operation even in case of error.

### ZCompress 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). |