# ZipSFX Component

The ZipSFX component implements a PKZip-compatible Zip compressor to create a self-extracting archive which will run natively on Windows platforms.

## Syntax

```text
nsoftware.IPWorksZip.ZipSFX
```

## Remarks

The component uses the Deflate algorithm specified in RFC 1951 for compression, and then creates a self-extracting executable archive. This exe will bring up a dialog that will allow the user to select the target directory in which to decompress the files. There is also an optional splash screen that may be displayed before decompression. The text for this splash screen may be set with the [BannerText](#bannertext-property-zipsfx-component) property. You can also set the text that appears on the title bar of each dialog box using the [CaptionText](#captiontext-property-zipsfx-component) property.

**Example (Creating a Self-Extracting Archive)**

```text
component.ArchiveFile = "c:\test.exe"
component.RecurseSubdirectories = true
component.SourceDirectory = "c:\foo\"
component.CaptionText = "Testing ZipSFX"
component.BannerText = "Press continue to decompress the archive."
component.CreateSFX()
```

Note: When creating a self-extracting archive which exceeds 4 GB or more of uncompressed data or which contains more than 64K files, the component will create a 64-bit Zip archive.

The self-extracting archive that is created by the ZipSFX component is a Windows application. However, there are command line options available if you wish to batch multiple files. The options are:

| Option Name | Description |
| --- | --- |
| targetpath | Path to decompress the archive to. This overrides the [ExtractToPath](#extracttopath-property-zipsfx-component). "." indicates the current directory (if no [ExtractToPath](#extracttopath-property-zipsfx-component) was specified and no targetpath is given, the archive is decompressed to the current directory). |
| overwrite | If set to true, the archive will automatically overwrite existing files (thus suppressing the message box asking you to overwrite or not) |
| displaymessage | If set to false, it will suppress the display of the "Extraction Complete" message after the archive has finished (this may also be accomplished by setting the [CompleteMessage](#CompleteMessage) config setting to ""). |
| openfile | If set to false, this option will override opening the file indicated by [FileToExecute](#filetoexecute-property-zipsfx-component). (Alternatively, set [FileToExecute](#filetoexecute-property-zipsfx-component) to ""). |
| password | The password used to decrypt the archive. If the archive is not encrypted this option is ignored. However if the archive is encrypted and no password is supplied, decompression will fail. |

For example, the following suppresses all questions and message boxes, and decompress to the current directory, use the following options:

```text
  ZipExtractor /targetpath="." /overwrite=1 /displaymessage=0 /openfile=0 /password=pass
```

Note that if you run the self-extracting archive with any command line options, the pop up message box containing the [BannerText](#bannertext-property-zipsfx-component) will be suppressed.

## 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-zipsfx-component) | The name of the self-extracting zip archive to create. |
| [BannerText](#bannertext-property-zipsfx-component) | Optional banner text to show before the self-extraction starts. |
| [CaptionText](#captiontext-property-zipsfx-component) | Optional caption (title) text for the self-extractor dialogs. |
| [CompressionLevel](#compressionlevel-property-zipsfx-component) | The compression level to use. |
| [ExtractToPath](#extracttopath-property-zipsfx-component) | Optional target directory for the self-extractor. |
| [FileToExecute](#filetoexecute-property-zipsfx-component) | Optional file to execute (open) after the archive is extracted. |
| [Password](#password-property-zipsfx-component) | An optional password for the self-extracting archive. |
| [RecurseSubdirectories](#recursesubdirectories-property-zipsfx-component) | Whether or not to recurse into subdirectories during archive creation. |
| [SourceDirectory](#sourcedirectory-property-zipsfx-component) | Directory to be compressed into a self-extracting 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.*

|  |  |
| --- | --- |
| [Config](#config-method-zipsfx-component) | Sets or retrieves a configuration setting. |
| [CreateSFX](#createsfx-method-zipsfx-component) | Compresses the files and creates a self-extracting archive. |
| [Reset](#reset-method-zipsfx-component) | Resets the component. |

## 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.*

|  |  |
| --- | --- |
| [Error](#error-event-zipsfx-component) | Information about non-fatal errors. |
| [Progress](#progress-event-zipsfx-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.*

|  |  |
| --- | --- |
| [CompleteMessage](#CompleteMessage) | Message to notify user that extraction has finished normally. |
| [ExtractorStub](#ExtractorStub) | Path to optional self-extractor executable stub. |
| [FileToExecuteParams](#FileToExecuteParams) | List of parameters to pass to FileToExecute. |
| [InstallationMode](#InstallationMode) | This setting will install to ExtractToPath, run FileToExecute, and then remove the extracted files. |
| [RequireAdminPrivs](#RequireAdminPrivs) | Specifies whether the created executable requires Administrator privileges. |
| [SilentExtraction](#SilentExtraction) | Specifies whether the archive should hide all UI interaction while extracting. |
| [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 ([ZipSFX](#zipsfx-component) Component)

The name of the self-extracting zip archive to create.

## Syntax

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

## Default Value

""

## Remarks

This property specifies the name of the archive to be written when CreateSFX is called. Any pre-existing archive file will be overwritten.

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 ".exe" extension. An extension will not automatically be appended by the component.

If the file cannot be written a trappable error will be generated.

**Example (Creating a Self-Extracting Archive)**

```text
component.ArchiveFile = "c:\test.exe"
component.RecurseSubdirectories = true
component.SourceDirectory = "c:\foo\"
component.CaptionText = "Testing ZipSFX"
component.BannerText = "Press continue to decompress the archive."
component.CreateSFX()
```

Note: When creating a self-extracting archive which exceeds 4 GB or more of uncompressed data or which contains more than 64K files, the component will create a 64-bit Zip archive.

# BannerText Property ([ZipSFX](#zipsfx-component) Component)

Optional banner text to show before the self-extraction starts.

## Syntax

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

## Default Value

""

## Remarks

If this property is set, a dialog box will pop up displaying the contents of this property as soon as the SFX executable is run. If this property is set to an empty string (default) no banner dialog will be displayed.

**Example (Creating a Self-Extracting Archive)**

```text
component.ArchiveFile = "c:\test.exe"
component.RecurseSubdirectories = true
component.SourceDirectory = "c:\foo\"
component.CaptionText = "Testing ZipSFX"
component.BannerText = "Press continue to decompress the archive."
component.CreateSFX()
```

# CaptionText Property ([ZipSFX](#zipsfx-component) Component)

Optional caption (title) text for the self-extractor dialogs.

## Syntax

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

## Default Value

""

## Remarks

This property contains the text which will appear on the title bar of the dialog boxes that appear when running the SFX executable file. If this property is not set, "IPWorks Zip Self Extractor - www.nsoftware.com" will appear in the title bar.

**Example (Creating a Self-Extracting Archive)**

```text
component.ArchiveFile = "c:\test.exe"
component.RecurseSubdirectories = true
component.SourceDirectory = "c:\foo\"
component.CaptionText = "Testing ZipSFX"
component.BannerText = "Press continue to decompress the archive."
component.CreateSFX()
```

# CompressionLevel Property ([ZipSFX](#zipsfx-component) Component)

The compression level to use.

## Syntax

```text
public int CompressionLevel { get; set; }
```

## Default Value

4

## Remarks

This property specifies the level of compression to be used, between 0 and 6. Higher values will cause the component to compress better; lower values will cause the component to compress faster. A value of 0 will store the file without compression.

# ExtractToPath Property ([ZipSFX](#zipsfx-component) Component)

Optional target directory for the self-extractor.

## Syntax

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

## Default Value

""

## Remarks

If set to empty string (default), the self-extractor will attempt to extract files into a subdirectory of the directory it is being executed from.

The name of the subdirectory is derived from the name of the self-extracting archive by removing its extension.

# FileToExecute Property ([ZipSFX](#zipsfx-component) Component)

Optional file to execute (open) after the archive is extracted.

## Syntax

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

## Default Value

"."

## Remarks

This property specifies an executable file which will be run after the archive has completed decompressing. This must be a relative path to a file located within [ExtractToPath](#extracttopath-property-zipsfx-component). If this property is set to ".", the folder to which the archive has been decompressed will open in Windows Explorer. If this property is set to "" (empty string), the extractor will close and take no action.

# Password Property ([ZipSFX](#zipsfx-component) Component)

An optional password for the self-extracting archive.

## Syntax

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

## Default Value

""

## Remarks

This property specifies a case-sensitive password used to encrypt or decrypt the archive. If set to an empty string (default), no encryption is used.

The maximum supported length of the password is 128 characters.

**Example (compressing an SFX archive):**

```text
component.ArchiveFile = "c:\test.exe"
component.RecurseSubdirectories = true
component.SourceDirectory = "c:\foo"
component.Password = "nsoftware"
component.CreateSFX()
```

# RecurseSubdirectories Property ([ZipSFX](#zipsfx-component) Component)

Whether or not to recurse into subdirectories during archive creation.

## Syntax

```text
public bool RecurseSubdirectories { get; set; }
```

## Default Value

True

## Remarks

If this property is set to true, when calling CreateSFX the component will recurse into all the subdirectories under [SourceDirectory](#sourcedirectory-property-zipsfx-component) and include them in the self extracting archive. If this property is false, only the files in [SourceDirectory](#sourcedirectory-property-zipsfx-component) will be included in the archive.

# SourceDirectory Property ([ZipSFX](#zipsfx-component) Component)

Directory to be compressed into a self-extracting archive.

## Syntax

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

## Default Value

""

## Remarks

This property specifies the name of the directory containing the files to be compressed. This may be a local or absolute path. If the [RecurseSubdirectories](#recursesubdirectories-property-zipsfx-component) property is true, all the subdirectories under SourceDirectory will be recursed into, and those files will also be compressed.

**Example (Creating a Self-Extracting Archive)**

```text
component.ArchiveFile = "c:\test.exe"
component.RecurseSubdirectories = true
component.SourceDirectory = "c:\foo\"
component.CaptionText = "Testing ZipSFX"
component.BannerText = "Press continue to decompress the archive."
component.CreateSFX()
```

# Config Method ([ZipSFX](#zipsfx-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-zipsfx-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-zipsfx-component), you must call *Config("PROPERTY")*. The value will be returned as a string.

# CreateSFX Method ([ZipSFX](#zipsfx-component) Component)

Compresses the files and creates a self-extracting archive.

## Syntax

```text
public void CreateSFX();

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

## Remarks

Invoking **CreateSFX** creates the archive specified by [ArchiveFile](#archivefile-property-zipsfx-component). When the method is called, all files specified by [SourceDirectory](#sourcedirectory-property-zipsfx-component) will be compressed and written to [ArchiveFile](#archivefile-property-zipsfx-component). If [RecurseSubdirectories](#recursesubdirectories-property-zipsfx-component) is true, all the subdirectories under [SourceDirectory](#sourcedirectory-property-zipsfx-component) and the files they contain will also be compressed and written to [ArchiveFile](#archivefile-property-zipsfx-component).

If [ArchiveFile](#archivefile-property-zipsfx-component) exists when you call CreateSFX it will be overwritten.

As the files in [SourceDirectory](#sourcedirectory-property-zipsfx-component) are being compressed, the [Progress](#progress-event-zipsfx-component) event will fire periodically to indicate how many bytes have been processed and the percentage of compression that has been completed.

To include your own custom text on the title bar of all of the self-extractor dialog boxes, set the [CaptionText](#captiontext-property-zipsfx-component) before calling CreateSFX. Setting the optional [BannerText](#bannertext-property-zipsfx-component) property will cause a small dialog to pop up when the self-extractor is run. You can put in a description of the contents, instructions, or any text you like.

**Example (Creating a Self-Extracting Archive)**

```text
component.ArchiveFile = "c:\test.exe"
component.RecurseSubdirectories = true
component.SourceDirectory = "c:\foo\"
component.CaptionText = "Testing ZipSFX"
component.BannerText = "Press continue to decompress the archive."
component.CreateSFX()
```

Note: When creating a self-extracting archive which exceeds 4 GB or more of uncompressed data or which contains more than 64K files, the component will create a 64-bit Zip archive.

The self-extracting archive that is created by the ZipSFX component is a Windows application. However, there are command line options available if you wish to batch multiple files. The options are:

| Option Name | Description |
| --- | --- |
| targetpath | Path to decompress the archive to. This overrides the [ExtractToPath](#extracttopath-property-zipsfx-component). "." indicates the current directory (if no [ExtractToPath](#extracttopath-property-zipsfx-component) was specified and no targetpath is given, the archive is decompressed to the current directory). |
| overwrite | If set to true, the archive will automatically overwrite existing files (thus suppressing the message box asking you to overwrite or not) |
| displaymessage | If set to false, it will suppress the display of the "Extraction Complete" message after the archive has finished (this may also be accomplished by setting the [CompleteMessage](#CompleteMessage) config setting to ""). |
| openfile | If set to false, this option will override opening the file indicated by [FileToExecute](#filetoexecute-property-zipsfx-component). (Alternatively, set [FileToExecute](#filetoexecute-property-zipsfx-component) to ""). |
| password | The password used to decrypt the archive. If the archive is not encrypted this option is ignored. However if the archive is encrypted and no password is supplied, decompression will fail. |

For example, the following suppresses all questions and message boxes, and decompress to the current directory, use the following options:

```text
  ZipExtractor /targetpath="." /overwrite=1 /displaymessage=0 /openfile=0 /password=pass
```

Note that if you run the self-extracting archive with any command line options, the pop up message box containing the [BannerText](#bannertext-property-zipsfx-component) will be suppressed.

# Reset Method ([ZipSFX](#zipsfx-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.

# Error Event ([ZipSFX](#zipsfx-component) Component)

Information about non-fatal errors.

## Syntax

```text
public event OnErrorHandler OnError;

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

public class ZipSFXErrorEventArgs : 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.

# Progress Event ([ZipSFX](#zipsfx-component) Component)

Fired as progress is made.

## Syntax

```text
public event OnProgressHandler OnProgress;

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

public class ZipSFXProgressEventArgs : EventArgs {
  public string FileName { get; }
  public long BytesProcessed { get; }
  public int PercentProcessed { get; }
}
```

## Remarks

The Progress event is automatically fired as compression is performed.

*FileName* contains the name of the file being written.

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

# Config Settings ([ZipSFX](#zipsfx-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-zipsfx-component) method.

### ZipSFX Config Settings

**CompleteMessage**: Message to notify user that extraction has finished normally. When the self-extracting executable created by this component successfully finishes extracting the files contained within itself, it may optionally display a Message Box indicating that it's finished. By default, the message "Extraction Complete." is displayed. You may change this to your own custom message. However, any message longer than 400 characters will be truncated. To disable this message, set the CompleteMessage configuration setting to "" (empty string).

**ExtractorStub**: Path to optional self-extractor executable stub. Normally the component loads a self-extractor stub from an internal resource and uses it to create the self-extracting executable.

If a path is specified in this setting, the file indicated by that path is used instead.

This setting allows you to specify a custom self-extractor. The compiled self-extractor stub is available on demand. Resources such as icons and text may then be modified.

This may also be used to specify if the resulting executable should be 32 bit or 64 bit by setting this to either "*32bit" or "*64bit".

**FileToExecuteParams**: List of parameters to pass to FileToExecute.This setting allows you to pass command-line parameters to the executable file indicated by [FileToExecute](#filetoexecute-property-zipsfx-component). Parameters should be in the form of a space-separated list.

**InstallationMode**: This setting will install to ExtractToPath, run FileToExecute, and then remove the extracted files. Is set to true, this setting makes the self-extractor behave as an installer by installing to a temp directory, running the desired executable, and removing the extracted files upon completion. The default value is false.

**RequireAdminPrivs**: Specifies whether the created executable requires Administrator privileges.This setting specifies whether the executable created by the component requires Administrator privileges to execute.

This setting is false by default.

**SilentExtraction**: Specifies whether the archive should hide all UI interaction while extracting.This setting specifies whether to hide the progress bar and success window when the archive executable is run. Setting this config to true is equivalent to passing the '/s' command-line parameter to the archive executable.

This setting is false by default.

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

### ZipSFX Errors

|  |  |
| --- | --- |
| 111 | Can't open file for read. |
| 112 | Can't open file for write. |
| 115 | Can't create empty archive. |
| 118 | The maximum size of the archive has been exceeded. |
| 119 | The archive must be specified. |
| 120 | The component is busy. |
| 150 | An I/O error has occurred (details follow). |
| 151 | Cannot find resource (details follow). |
| 152 | Cannot update resource (details follow). |