# Zip Component

The Zip component implements a PKZip-compatible Zip compressor and decompressor.

## Syntax

```text
TipzZip
```

## Remarks

The component uses the Deflate algorithm specified in RFC 1951 for compression, and produces and reads output compatible with PKZip, WinZip, etc.

To create a new archive, first set the [ArchiveFile](#archivefile-property-zip-component) property to the name of the archive to be created. Then, specify the files to be compressed either by invoking [IncludeFiles](#includefiles-method-zip-component), or by adding a new object to the Files collection and setting the values of the [FileDecompressedName](#filedecompressedname-property-zip-component) and [FileCompressedName](#filecompressedname-property-zip-component). fields. Finally, call the [Compress](#compress-method-zip-component) method to create the archive.

To decompress an existing archive, set [ArchiveFile](#archivefile-property-zip-component) to the name of the archive to be decompressed. The [ExtractToPath](#extracttopath-property-zip-component) property may be set, and then calling the [ExtractAll](#extractall-method-zip-component) method will decompress all files in the archive to this path.

For finer control, the [Scan](#scan-method-zip-component) method should be used to read the file information stored in the archive. This will fill out the information in the Files collection. The values of [FileDecompressedName](#filedecompressedname-property-zip-component) may then be changed if desired. Finally, [ExtractAll](#extractall-method-zip-component) may be used to decompress the entire archive, or [Extract](#extract-method-zip-component) may be used for finer control.

Data may be streamed out by setting [WriteToProgressEvent](#WriteToProgressEvent) to true. Then, the [Progress](#progress-event-zip-component) event may be trapped to retrieve the data.

**Example (Creating an Archive)**

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

**Example (Extracting from an Archive)**

```text
ZipControl.ArchiveFile = "c:\temp.zip"
ZipControl.ExtractToPath = "c:\extracted\"
ZipControl.ExtractAll()
```

## 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-zip-component) | The name of the zip, gzip, tar, or jar archive. |
| [CompressionLevel](#compressionlevel-property-zip-component) | The compression level to use. |
| [CompressionMethod](#compressionmethod-property-zip-component) | The compression method to use. |
| [EncryptionAlgorithm](#encryptionalgorithm-property-zip-component) | The algorithm used to encrypt files written to the archive. |
| [ExcludedFiles](#excludedfiles-property-zip-component) | A list of files to exclude. |
| [ExtractToPath](#extracttopath-property-zip-component) | A base path to decompress to. |
| [FileCount](#filecount-property-zip-component) | The number of records in the File arrays. |
| [FileAttributes](#fileattributes-property-zip-component) | The attributes of the files to be compressed or decompressed. |
| [FileComment](#filecomment-property-zip-component) | Specifies a comment for the entry in the zip file. |
| [FileCompressedDate](#filecompresseddate-property-zip-component) | The date and time of the entry, as stored within the archive. |
| [FileCompressedName](#filecompressedname-property-zip-component) | The file name of the current file, as stored inside of the archive. |
| [FileCompressedSize](#filecompressedsize-property-zip-component) | The size of the compressed data, as compressed within the archive. |
| [FileCompressionLevel](#filecompressionlevel-property-zip-component) | The compression level to use for the file. |
| [FileCRC](#filecrc-property-zip-component) | The CRC value for the specified file found in the archive. |
| [FileDecompressedName](#filedecompressedname-property-zip-component) | The name of the file in the archive, as stored on the file system, outside the archive. |
| [FileDecompressedSize](#filedecompressedsize-property-zip-component) | The size of the file, as decompressed outside the archive. |
| [FileEncryptionAlgorithm](#fileencryptionalgorithm-property-zip-component) | The algorithm used to encrypt the specified file written to the archive. |
| [FileHash](#filehash-property-zip-component) | The computed hash for the specified File. |
| [FileInputData](#fileinputdata-property-zip-component) | When This property is set, the component will read in the data from This property instead of reading from the file contained in the DecompressedName property. |
| [FilePassword](#filepassword-property-zip-component) | This property specifies the case-sensitive password used to encrypt or decrypt the current file. |
| [FilePasswordRequired](#filepasswordrequired-property-zip-component) | This property describes whether or not the current file has been encrypted or not and requires a password to decompress. |
| [OverwriteFiles](#overwritefiles-property-zip-component) | Whether or not to overwrite files. |
| [Password](#password-property-zip-component) | A password for the zip archive. |
| [RecurseSubdirectories](#recursesubdirectories-property-zip-component) | Whether or not to recurse into subdirectories. |
| [ZipComment](#zipcomment-property-zip-component) | The comment for the entire zip file. |
| [ZipData](#zipdata-property-zip-component) | (Decompression only) The zip 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-zip-component) | Aborts the current operation. |
| [AbortBatch](#abortbatch-method-zip-component) | Aborts the current batch without modifying the archive. |
| [AppendFiles](#appendfiles-method-zip-component) | Adds specified files to an existing archive. |
| [Compress](#compress-method-zip-component) | Creates the compressed archive. |
| [Config](#config-method-zip-component) | Sets or retrieves a configuration setting. |
| [Delete](#delete-method-zip-component) | Deletes one or more files from an existing archive. |
| [Extract](#extract-method-zip-component) | Extracts a single file, directory, or group of files, from the archive. |
| [ExtractAll](#extractall-method-zip-component) | Extracts all files from the compressed archive. |
| [IncludeFiles](#includefiles-method-zip-component) | Specifies that the indicated files should be added to the archive. |
| [ProcessBatch](#processbatch-method-zip-component) | Processes the operations queued in the current batch. |
| [Reset](#reset-method-zip-component) | Resets the component. |
| [Scan](#scan-method-zip-component) | Scans the compressed archive. |
| [StartBatch](#startbatch-method-zip-component) | Starts a batch session for queued archive updates. |
| [Update](#update-method-zip-component) | Will update certain files in an archive. |

## 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-zip-component) | Fired before each file is processed. |
| [EndFile](#endfile-event-zip-component) | Fired after each file is processed. |
| [Error](#error-event-zip-component) | Information about non-fatal errors. |
| [Overwrite](#overwrite-event-zip-component) | Fired whenever a file exists and may be overwritten. |
| [Password](#password-event-zip-component) | Fired when a file is encrypted, and the file's password is incorrect. |
| [Progress](#progress-event-zip-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.*

|  |  |
| --- | --- |
| [AESGenerateUniqueKeys](#AESGenerateUniqueKeys) | Whether to generate unique keys for each file encrypted. |
| [CheckForFileLocks](#CheckForFileLocks) | If true, the component requests an exclusive lock during initialization. |
| [CompressionMethod](#CompressionMethod) | Used to set the method of compression. |
| [EnableStreamingEncryption](#EnableStreamingEncryption) | Whether to allow streaming and encryption simultaneously. |
| [ExcludedAttributes](#ExcludedAttributes) | Attributes of files to be excluded. |
| [ExtractFilesOnly](#ExtractFilesOnly) | Whether to only extract the files contained within the archive. |
| [FileHashAlgorithm](#FileHashAlgorithm) | The algorithm to use when computing the file hash. |
| [FileNamesCaseSensitive](#FileNamesCaseSensitive) | This config controls the case-sensitivity of the component when working with filenames. |
| [ForceZip64Format](#ForceZip64Format) | Whether to explicitly compress a Zip64 format archive. |
| [MarkAsText](#MarkAsText) | Whether to mark files as text files. |
| [OverwriteReadonlyFiles](#OverwriteReadonlyFiles) | Whether to overwrite readonly files. |
| [PreserveModifiedTime](#PreserveModifiedTime) | Whether or not to preserve the original modified time on extracted files. |
| [RecalculateCRC](#RecalculateCRC) | Whether to recalculate the CRC. |
| [TempPath](#TempPath) | Specifies the directory path where temporary files are written. |
| [UseIBM437ASDefaultEncoding](#UseIBM437ASDefaultEncoding) | Whether or not to use the IBM437 default encoding. |
| [VerifyPassword](#VerifyPassword) | Check whether the specified Password can decrypt the archive without extracting files. |
| [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. |

# ArchiveFile Property ([Zip](#zip-component) Component)

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

## Syntax

*C++ Builder Syntax*

```text
__property String ArchiveFile = { read=FArchiveFile, write=FSetArchiveFile };
```

## 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-zip-component), [Extract](#extract-method-zip-component), or [ExtractAll](#extractall-method-zip-component) 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-zip-component) is called, the file named by ArchiveFile will be written; if a file of this name already exists the [Overwrite](#overwrite-event-zip-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-zip-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 ("").

## Data Type

String

# CompressionLevel Property ([Zip](#zip-component) Component)

The compression level to use.

## Syntax

*C++ Builder Syntax*

```text
__property int CompressionLevel = { read=FCompressionLevel, write=FSetCompressionLevel };
```

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

Set the level of CompressionLevel in the [BeginFile](#beginfile-event-zip-component) event to apply different levels of compression to different files.

## Data Type

Integer

# CompressionMethod Property ([Zip](#zip-component) Component)

The compression method to use.

## Syntax

*C++ Builder Syntax*

```text
__property TipzZipCompressionMethods CompressionMethod = { read=FCompressionMethod, write=FSetCompressionMethod };
enum TipzZipCompressionMethods {
  cmDeflate=0,
  cmPPMd=1,
  cmBzip2=2
};
```

## Default Value

cmDeflate

## Remarks

This property specifies the compression method to use. By default the component uses the Deflate compression method (a value of 0). Supported values are:

- 0 (cmDeflate - default)
- 1 (cmPPMd)
- 2 (cmBzip2)

## Data Type

Integer

# EncryptionAlgorithm Property ([Zip](#zip-component) Component)

The algorithm used to encrypt files written to the archive.

## Syntax

*C++ Builder Syntax*

```text
__property TipzZipEncryptionAlgorithms EncryptionAlgorithm = { read=FEncryptionAlgorithm, write=FSetEncryptionAlgorithm };
enum TipzZipEncryptionAlgorithms {
  eaDefault=0,
  eaAESWeak=1,
  eaAESStrong=2,
  eaAESMaximum=3
};
```

## Default Value

eaDefault

## Remarks

The algorithm used to encrypt files written to the archive.

Note that files will only be encrypted if [Password](#password-property-zip-component) is set. By default the component will use standard zip encryption if [Password](#password-property-zip-component) is set, and will not encrypt data otherwise.

The component supports the use of **AES**, the Advanced Encryption Standard, as well as standard Zip encryption. The default encryption algorithm is the algorithm introduced in version 2.0 of the Zip specification, and is compatible with virtually all other zip utilities. However, this algorithm is considered weak and should not be used to protect sensitive data.

**AES** is a U.S. government standard cleared to protect even the most sensitive data. The file format used to create AES-encrypted files is designed to be **compatible** with **WinZip 9.0**. AES-encrypted files created by the component may or may not be compatible with other Zip utilities.

The component supports the use of AES with key lengths of 128, 192, or 256 bits. Note that even with the weakest (128-bit) keys AES is much more secure than standard Zip encryption.

If you use *strong* or *maximum* AES encryption the component will generate a unique salt value and cryptographic key for each file encrypted. If you use *weak* encryption the component will use the same salt for each file in the archive. If you are encrypting a large number of files this will have a substantial effect on performance. Set the *AESGenerateUniqueKeys* configuration setting to configure the salt generation independent of the key length.

If using AES encryption it is important to choose a good [Password](#password-property-zip-component). For 128-bit keys it is recommended that your password be 32 characters long, and for 256-bit keys, 64 characters.

**Important:** Note that AES encryption only encrypts the contents of encrypted files within the Zip archive; it does not prevent an attacker from reading the names of files in the archive, or from adding or deleting files to or from the archive. To prevent this consider first storing your files in an unencrypted zip file, and then storing this zip file in another, AES-encrypted zip file.

Property values:

|  |  |
| --- | --- |
| eaDefault | 0 |
| eaAESWeak | 1 |
| eaAESStrong | 2 |
| eaAESMaximum | 3 |

## Data Type

Integer

# ExcludedFiles Property ([Zip](#zip-component) Component)

A list of files to exclude.

## Syntax

*C++ Builder Syntax*

```text
__property String ExcludedFiles = { read=FExcludedFiles, write=FSetExcludedFiles };
```

## Default Value

""

## Remarks

This property specifies files that should be excluded when [Compress](#compress-method-zip-component) or [Extract](#extract-method-zip-component) is invoked. When [Compress](#compress-method-zip-component) is invoked, each value of [FileDecompressedName](#filedecompressedname-property-zip-component) in Files will be compared to ExcludedFiles, and each file will be excluded if the name matches. When [Extract](#extract-method-zip-component) is called, each value of [FileCompressedName](#filecompressedname-property-zip-component) in Files matching the parameter to [Extract](#extract-method-zip-component) will be compared to ExcludedFiles, and will be excluded if appropriate. Calling the [ExtractAll](#extractall-method-zip-component) method will ignore this property and extract all files in the archive.

This property may be set to one or more filenames or directory names. Files may be specified with or without a path, and with or without wildcards. If a path is specified, files in the indicated directory will be excluded; subdirectories will be recursed into if [RecurseSubdirectories](#recursesubdirectories-property-zip-component) is true. If no path is specified but wildcards are, matching files in all directories will be excluded. If a single filename without a path is specified, it must correspond exactly to the appropriate value of [FileCompressedName](#filecompressedname-property-zip-component) or [FileDecompressedName](#filedecompressedname-property-zip-component).

Directories should end with a slash ("/" or "\", as appropriate.) If a directory is specified, all files and subdirectories in the specified directory will be excluded.

A pipe character ("|") should be used to separate multiple file or directory names.

The following examples illustrate the use of the property:

**Example**

```text
ZipControl.ArchiveFile = "c:\test.zip"
ZipControl.IncludeFiles("c:\test\*")
ZipControl.ExcludedFiles = "*.tmp"
ZipControl.Compress()
```

 **Example**

```text
ZipControl.ArchiveFile = "c:\test.tar"
ZipControl.Scan()
ZipControl.ExcludedFiles = "*.bak | backup/"
ZipControl.ExtractToPath = "c:\temp"
ZipControl.Extract("*")
```

 As per the examples, the property should be specified differently for compression and decompression. When invoking [Compress](#compress-method-zip-component), the format of ExcludedFiles should correspond to that of the local file system. When invoking [Extract](#extract-method-zip-component) the format should correspond to standard (UNIX) format, and should not contain drive letters or backslashes.

You may exclude files based on their *attributes* as well: See the *ExcludedAttributes* configuration setting for more information.

If the property is set to the empty string, no files will be excluded. This property is never reset automatically, so be sure to reset it manually if using a single instance of the component for both compression and extraction. Failure to do so may result in I/O errors or unexpected results.

## Data Type

String

# ExtractToPath Property ([Zip](#zip-component) Component)

A base path to decompress to.

## Syntax

*C++ Builder Syntax*

```text
__property String ExtractToPath = { read=FExtractToPath, write=FSetExtractToPath };
```

## Default Value

""

## Remarks

Setting the ExtractToPath property affects the operation of the [Extract](#extract-method-zip-component) and [ExtractAll](#extractall-method-zip-component) 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](#filedecompressedname-property-zip-component) 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.

**Example (Extracting from an Archive)**

```text
ZipControl.ArchiveFile = "c:\temp.zip"
ZipControl.ExtractToPath = "c:\extracted\"
ZipControl.ExtractAll()
```

**Example - Adding Files**

```text
Dim i as Integer
ZipControl.ArchiveFile = "c:\test.zip"
ZipControl.Scan()
For i = 0 to ZipControl.Files.Count - 1
  ZipControl.Files(i).DecompressedName(i) = "c:\temp\" + ZipControl.Files(i).DecompressedName
Next i
ZipControl.ExtractToPath = ""
ZipControl.ExtractAll()
ZipControl.IncludeFiles("c:\extra\*")
ZipControl.Compress()
```

## Data Type

String

# FileCount Property ([Zip](#zip-component) Component)

The number of records in the File arrays.

## Syntax

*C++ Builder Syntax*

```text
__property int FileCount = { read=FFileCount, write=FSetFileCount };
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [FileAttributes](#fileattributes-property-zip-component)
- [FileComment](#filecomment-property-zip-component)
- [FileCompressedDate](#filecompresseddate-property-zip-component)
- [FileCompressedName](#filecompressedname-property-zip-component)
- [FileCompressedSize](#filecompressedsize-property-zip-component)
- [FileCompressionLevel](#filecompressionlevel-property-zip-component)
- [FileCRC](#filecrc-property-zip-component)
- [FileDecompressedName](#filedecompressedname-property-zip-component)
- [FileDecompressedSize](#filedecompressedsize-property-zip-component)
- [FileEncryptionAlgorithm](#fileencryptionalgorithm-property-zip-component)
- [FileHash](#filehash-property-zip-component)
- [FileInputData](#fileinputdata-property-zip-component)
- [FilePassword](#filepassword-property-zip-component)
- [FilePasswordRequired](#filepasswordrequired-property-zip-component)

The array indices start at *0* and end at *FileCount - 1*.

This property is not available at design time.

## Data Type

Integer

# FileAttributes Property ([Zip](#zip-component) Component)

The attributes of the files to be compressed or decompressed.

## Syntax

*C++ Builder Syntax*

```text
__property int FileAttributes[int FileIndex] = { read=FFileAttributes, write=FSetFileAttributes };
```

## Default Value

0

## Remarks

The attributes of the files to be compressed or decompressed. It will then be written to the archive during compression and to the file system during extraction.

If desired, you may change the value of **Attributes** before compressing or decompressing.

The property is a bitmask of flags, corresponding to the MS-DOS directory byte:

|  |  |
| --- | --- |
| Readonly | 1 |
| Hidden | 2 |
| System | 4 |
| Directory | 16 |
| Archive | 32 |

In the **Java Edition**, due to limitations of the JRE, the effect of this property is limited. When including files, only the *Hidden* and *Readonly* bits will be read from the file system, and during extraction only the *Readonly* attribute will be written.

The *FileIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FileCount](#filecount-property-zip-component) property.

This property is not available at design time.

## Data Type

Integer

# FileComment Property ([Zip](#zip-component) Component)

Specifies a comment for the entry in the zip file.

## Syntax

*C++ Builder Syntax*

```text
__property String FileComment[int FileIndex] = { read=FFileComment, write=FSetFileComment };
```

## Default Value

""

## Remarks

Specifies a comment for the entry in the zip file. Before compression, set This property to include comments in this zip file. After an archive has been scanned, This property will contain any comments the zip file contains.

The *FileIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FileCount](#filecount-property-zip-component) property.

This property is not available at design time.

## Data Type

String

# FileCompressedDate Property ([Zip](#zip-component) Component)

The date and time of the entry, as stored within the archive.

## Syntax

*C++ Builder Syntax*

```text
__property __int64 FileCompressedDate[int FileIndex] = { read=FFileCompressedDate, write=FSetFileCompressedDate };
```

## Default Value

0

## Remarks

The date and time of the entry, as stored within the archive.

**FileCompressedDate** contains the last modified date of the file, as stored within the archive (it does not generally correspond to when the file was compressed).

**FileCompressedDate** is returned in a platform-specific format. The **Java**,**C++**, and most other Editions will return the number of milliseconds since January 1, 1970, 00:00:00. This value may be passed directly to the *java.util.Date* constructor to create a *java.util.Date* object representing this date.

The **.NET** Edition will return the number of ticks, or 100-nanosecond intervals, since January 1, 0001, 00:00:00. This value may be passed directly to the *System.DateTime* constructor to create a *System.DateTime* object representing this date.

Reading the value of this property will return a meaningful value only after the archive has been successfully scanned or decompressed, and only if the values of ArchiveFile, Files collection, and [FileCompressedName](#filecompressedname-property-zip-component) have not been changed since. If a meaningful value is not available this property will return a value of 0.

NOTE: This may be set accordingly when the [FileInputStream](#Zip_p_FileInputStream) property is set to a valid stream to input the data for the current file. If not set, the default, 0, is used. Otherwise the value is read from disk.

The *FileIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FileCount](#filecount-property-zip-component) property.

This property is not available at design time.

## Data Type

Long64

# FileCompressedName Property ([Zip](#zip-component) Component)

The file name of the current file, as stored inside of the archive.

## Syntax

*C++ Builder Syntax*

```text
__property String FileCompressedName[int FileIndex] = { read=FFileCompressedName, write=FSetFileCompressedName };
```

## Default Value

""

## Remarks

The file name of the current file, as stored inside of the archive. This may be the same as in [FileDecompressedName](#filedecompressedname-property-zip-component), but is not required to be.

All paths are stored in the archive in standard (UNIX) format. Pathnames specified in the host operating system's format will be immediately converted.

This field should generally be set with a relative path or with no path at all. The exact interpretation of the path is left to the decompression software; generally, pathnames will be interpreted as relative to a base directory, and these subdirectories will be created as needed. Absolute pathnames (paths beginning with a */* character) will not be interpreted correctly by the component, and may or may not be interpreted correctly by other decompression software.

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

**Example**

```text
ZipControl.ArchiveFile = "c:\test.zip"
ZipControl.Files.Add(new ZIPFile())
ZipControl.Files[0].DecompressedName = "c:\test\ipworkszip\temp\test.txt"
ZipControl.Files[0].CompressedName = "readme.txt"
ZipControl.Compress()
```

The *FileIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FileCount](#filecount-property-zip-component) property.

This property is not available at design time.

## Data Type

String

# FileCompressedSize Property ([Zip](#zip-component) Component)

The size of the compressed data, as compressed within the archive.

## Syntax

*C++ Builder Syntax*

```text
__property __int64 FileCompressedSize[int FileIndex] = { read=FFileCompressedSize };
```

## Default Value

-1

## Remarks

The size of the compressed data, as compressed within the archive. Headers, footers, etc., are not included in the size.

Reading the value of this property will return a meaningful value only after the archive has been compressed, scanned, or decompressed, and only if the values of [ArchiveFile](#Jar_p_ArchiveFile), or [Files](#Jar_p_Files) have not been changed since. If a meaningful value is not available this property will return a value of -1.

The *FileIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FileCount](#filecount-property-zip-component) property.

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

## Data Type

Long64

# FileCompressionLevel Property ([Zip](#zip-component) Component)

The compression level to use for the file.

## Syntax

*C++ Builder Syntax*

```text
__property int FileCompressionLevel[int FileIndex] = { read=FFileCompressionLevel, write=FSetFileCompressionLevel };
```

## Default Value

4

## Remarks

The compression level to use for the file. 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.

The *FileIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FileCount](#filecount-property-zip-component) property.

This property is not available at design time.

## Data Type

Integer

# FileCRC Property ([Zip](#zip-component) Component)

The CRC value for the specified file found in the archive.

## Syntax

*C++ Builder Syntax*

```text
__property __int64 FileCRC[int FileIndex] = { read=FFileCRC };
```

## Default Value

0

## Remarks

The [FileCRC](#filecrc-property-zip-component) value for the specified file found in the archive. This value is populated after compression or decompression.

The *FileIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FileCount](#filecount-property-zip-component) property.

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

## Data Type

Long64

# FileDecompressedName Property ([Zip](#zip-component) Component)

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

## Syntax

*C++ Builder Syntax*

```text
__property String FileDecompressedName[int FileIndex] = { read=FFileDecompressedName, write=FSetFileDecompressedName };
```

## Default Value

""

## Remarks

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

When compressing files, 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 during compression, a trappable error will be generated, and the archive will not be correctly written.

When decompressing files, the property indicates where the file should be written. After the archive is scanned, the values of [FileCompressedName](#filecompressedname-property-zip-component) and **DecompressedName** will be set to the exact filenames found in the archive. The value of **DecompressedName** may then be changed if desired.

If **DecompressedName** is set to an empty string before extraction, the file will not be written to disk at all. It will still be written to the **Progress** event if WriteToProgressEvent is set to true.

If **DecompressedName** is set to an empty string before compression, the file will be skipped, and not written to the archive.

A base path for decompression may be specified by setting the ExtractToPath property. If ExtractToPath is set to a non-empty string, the files will be decompressed to the directory specified in ExtractToPath. If the value of [FileDecompressedName](#filedecompressedname-property-zip-component) contains a pathname it will be regarded as relative to ExtractToPath.

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.

**Example**

```text
ZipControl.ArchiveFile = "c:\test.tar"
ZipControl.Scan()
ZipControl.ExtractToPath = "c:\temp\"
ZipControl.Files[1].DecompressedName = "test\temp.out"
ZipControl.Extract(ZipControl.Files[1].CompressedName)
```

 **Incorrect Example**

```text
ZipControl.ExtractToPath = "c:\temp\"
ZipControl.Files[1].DecompressedName = "c:\temp\test\temp.out"
'The file would be extracted to c:\temp\c:\temp\test\temp.out
```

The *FileIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FileCount](#filecount-property-zip-component) property.

This property is not available at design time.

## Data Type

String

# FileDecompressedSize Property ([Zip](#zip-component) Component)

The size of the file, as decompressed outside the archive.

## Syntax

*C++ Builder Syntax*

```text
__property __int64 FileDecompressedSize[int FileIndex] = { read=FFileDecompressedSize };
```

## Default Value

-1

## Remarks

The size of the file, as decompressed outside the archive. If an archive is open for read (i.e. has been scanned or decompressed), this information will be read from the archive headers. If an archive is not open for read, the component will retrieve the information for the corresponding value of [FileDecompressedName](#filedecompressedname-property-zip-component) from the local file system.

A value of -1 will be returned in case of an I/O error.

The *FileIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FileCount](#filecount-property-zip-component) property.

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

## Data Type

Long64

# FileEncryptionAlgorithm Property ([Zip](#zip-component) Component)

The algorithm used to encrypt the specified file written to the archive.

## Syntax

*C++ Builder Syntax*

```text
__property TipzZipFileEncryptionAlgorithms FileEncryptionAlgorithm[int FileIndex] = { read=FFileEncryptionAlgorithm, write=FSetFileEncryptionAlgorithm };
enum TipzZipFileEncryptionAlgorithms {
  eaDefault=0,
  eaAESWeak=1,
  eaAESStrong=2,
  eaAESMaximum=3
};
```

## Default Value

eaDefault

## Remarks

The algorithm used to encrypt the specified file written to the archive.

Note that the file will only be encrypted if [FilePassword](#filepassword-property-zip-component) is set. By default the component will use standard zip encryption if [FilePassword](#filepassword-property-zip-component) is set, and will not encrypt data otherwise.

The component supports the use of **AES**, the Advanced Encryption Standard, as well as standard Zip encryption. The default encryption algorithm is the algorithm introduced in version 2.0 of the Zip specification, and is compatible with virtually all other zip utilities. However, this algorithm is considered weak and should not be used to protect sensitive data.

**AES** is a U.S. government standard cleared to protect even the most sensitive data. The file format used to create AES-encrypted files is designed to be **compatible** with **WinZip 9.0**. AES-encrypted files created by the component may or may not be compatible with other Zip utilities.

The component supports the use of AES with key lengths of 128, 192, or 256 bits. Note that even with the weakest (128-bit) keys AES is much more secure than standard Zip encryption.

If you use *strong* or *maximum* AES encryption the component will generate a unique salt value and cryptographic key for each file encrypted. If you use *weak* encryption the component will use the same salt for each file in the archive. If you are encrypting a large number of files this will have a substantial effect on performance. Set the *AESGenerateUniqueKeys* configuration setting to configure the salt generation independent of the key length.

If using AES encryption it is important to choose a good [FilePassword](#filepassword-property-zip-component). For 128-bit keys it is recommended that your password be 32 characters long, and for 256-bit keys, 64 characters.

**Important:** Note that AES encryption only encrypts the contents of encrypted files within the Zip archive; it does not prevent an attacker from reading the names of files in the archive, or from adding or deleting files to or from the archive. To prevent this consider first storing your files in an unencrypted zip file, and then storing this zip file in another, AES-encrypted zip file.

To set the [FileEncryptionAlgorithm](#fileencryptionalgorithm-property-zip-component) or [FilePassword](#filepassword-property-zip-component) properties for the entire archive, use the [EncryptionAlgorithm](#encryptionalgorithm-property-zip-component) or [Password](#password-property-zip-component) properties.

Property values:

|  |  |
| --- | --- |
| eaDefault | 0 |
| eaAESWeak | 1 |
| eaAESStrong | 2 |
| etAESMaximum | 3 |

The *FileIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FileCount](#filecount-property-zip-component) property.

This property is not available at design time.

## Data Type

Integer

# FileHash Property ([Zip](#zip-component) Component)

The computed hash for the specified File.

## Syntax

*C++ Builder Syntax*

```text
__property String FileHash[int FileIndex] = { read=FFileHash };
```

## Default Value

""

## Remarks

The computed hash for the specified File.

This property is populated with the hash value computed for the specified file after calling [Compress](#compress-method-zip-component). This property is only applicable if the [FileHashAlgorithm](#FileHashAlgorithm) configuration setting is set.

The *FileIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FileCount](#filecount-property-zip-component) property.

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

## Data Type

String

# FileInputData Property ([Zip](#zip-component) Component)

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

## Syntax

*C++ Builder Syntax*

```text
__property String FileInputData[int FileIndex] = { read=FFileInputData, write=FSetFileInputData };
__property DynamicArray<Byte> FileInputDataB[int FileIndex] = { read=FFileInputDataB, write=FSetFileInputDataB };
```

## 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-zip-component) property.

The *FileIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FileCount](#filecount-property-zip-component) property.

This property is not available at design time.

## Data Type

Byte Array

# FilePassword Property ([Zip](#zip-component) Component)

This property specifies the case-sensitive password used to encrypt or decrypt the current file.

## Syntax

*C++ Builder Syntax*

```text
__property String FilePassword[int FileIndex] = { read=FFilePassword, write=FSetFilePassword };
```

## Default Value

""

## Remarks

This property specifies the case-sensitive password used to encrypt or decrypt the current file. If set to an empty string, no password is used.

For archives that have multiple files with the same password, you may use the [Password](#password-property-zip-component) property instead of the [Password](#password-property-zip-component) property of the [Files](#Zip_p_Files) collection. You may also use [FilePasswordRequired](#filepasswordrequired-property-zip-component) property to see if a file requires a password after an archive has been scanned.

In this release, streaming out of encrypted archives is not supported. When compressing, [WriteToProgressEvent](#WriteToProgressEvent) must be set to false if **Password** is set.

**Example (Compressing an Archive)**

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

The *FileIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FileCount](#filecount-property-zip-component) property.

This property is not available at design time.

## Data Type

String

# FilePasswordRequired Property ([Zip](#zip-component) Component)

This property describes whether or not the current file has been encrypted or not and requires a password to decompress.

## Syntax

*C++ Builder Syntax*

```text
__property bool FilePasswordRequired[int FileIndex] = { read=FFilePasswordRequired };
```

## Default Value

false

## Remarks

This property describes whether or not the current file has been encrypted or not and requires a password to decompress. It is populated after the archive has been scanned.

The *FileIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FileCount](#filecount-property-zip-component) property.

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

## Data Type

Boolean

# OverwriteFiles Property ([Zip](#zip-component) Component)

Whether or not to overwrite files.

## Syntax

*C++ Builder Syntax*

```text
__property bool OverwriteFiles = { read=FOverwriteFiles, write=FSetOverwriteFiles };
```

## Default Value

true

## Remarks

If this property is set to true, existing files will be overwritten when decompressing. When [Extract](#extract-method-zip-component) or [ExtractAll](#extractall-method-zip-component) is called, each file specified in Files will be checked for existence. If a file exists, the [Overwrite](#overwrite-event-zip-component) event will be fired, and the files will be overwritten if OverwriteFiles is set to true.

More precise control of which files should be overwritten may be gained by listening to the [Overwrite](#overwrite-event-zip-component) event and altering its parameters when the event is fired.

This property only affects the operation of [Extract](#extract-method-zip-component) and [ExtractAll](#extractall-method-zip-component). When compressing files, [ArchiveFile](#archivefile-property-zip-component) will always be overwritten unless the user specifies otherwise in the [Overwrite](#overwrite-event-zip-component) event.

## Data Type

Boolean

# Password Property ([Zip](#zip-component) Component)

A password for the zip archive.

## Syntax

*C++ Builder Syntax*

```text
__property String Password = { read=FPassword, write=FSetPassword };
```

## Default Value

""

## Remarks

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

Streaming encrypted archives is supported when [EnableStreamingEncryption](#EnableStreamingEncryption) is set to true. When compressing, [WriteToProgressEvent](#WriteToProgressEvent) must be set to false if Password is set.

**Example (Compressing an Archive)**

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

## Data Type

String

# RecurseSubdirectories Property ([Zip](#zip-component) Component)

Whether or not to recurse into subdirectories.

## Syntax

*C++ Builder Syntax*

```text
__property bool RecurseSubdirectories = { read=FRecurseSubdirectories, write=FSetRecurseSubdirectories };
```

## Default Value

true

## Remarks

This property affects the behavior of [IncludeFiles](#includefiles-method-zip-component) and [Extract](#extract-method-zip-component) and the meaning of [ExcludedFiles](#excludedfiles-property-zip-component). If this property is set to true, [IncludeFiles](#includefiles-method-zip-component) will recurse into all subdirectories whenever it performs a search on the file system.

Be sure RecurseSubdirectories is set to the appropriate value before invoking [IncludeFiles](#includefiles-method-zip-component), [Extract](#extract-method-zip-component), or [Compress](#compress-method-zip-component); changing the value of this property after method calls will not retroactively alter their effects.

**Example (Creating an Archive)**

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

## Data Type

Boolean

# ZipComment Property ([Zip](#zip-component) Component)

The comment for the entire zip file.

## Syntax

*C++ Builder Syntax*

```text
__property String ZipComment = { read=FZipComment, write=FSetZipComment };
```

## Default Value

""

## Remarks

Specifies a global comment for the zip file. Set this property before invoking [Compress](#compress-method-zip-component) to include a comment in the zip file. Read it after invoking [Scan](#scan-method-zip-component) to read the zip comment.

## Data Type

String

# ZipData Property ([Zip](#zip-component) Component)

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

## Syntax

*C++ Builder Syntax*

```text
__property String ZipData = { read=FZipData, write=FSetZipData };
__property DynamicArray<Byte> ZipDataB = { read=FZipDataB, write=FSetZipDataB };
```

## Default Value

""

## Remarks

Normally you should set [ArchiveFile](#archivefile-property-zip-component) before invoking [Scan](#scan-method-zip-component) or [Extract](#extract-method-zip-component). If you prefer to read the zip file from memory you may set ZipData instead. ZipData should be set to the entire contents of the zip 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 after invoking [Scan](#scan-method-zip-component), you should set the value of [FileDecompressedName](#filedecompressedname-property-zip-component) for each file in the Files collection to an empty string. Then, when you invoke [Extract](#extract-method-zip-component) (or [ExtractAll](#extractall-method-zip-component)) the data will be provided in the [Progress](#progress-event-zip-component) event.

This property is write-only. Note that modifying a zip file stored in ZipData is not supported, so Append, [Delete](#delete-method-zip-component), etc., will throw exceptions.

This property is not available at design time.

## Data Type

Byte Array

# Abort Method ([Zip](#zip-component) Component)

Aborts the current operation.

## Syntax

*C++ Builder Syntax*

```text
void __fastcall Abort();
```

## Remarks

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

In case Append or [Delete](#delete-method-zip-component) is aborted the archive will be left in its original state.

# AbortBatch Method ([Zip](#zip-component) Component)

Aborts the current batch without modifying the archive.

## Syntax

*C++ Builder Syntax*

```text
void __fastcall AbortBatch();
```

## Remarks

This method discards the pending operations queued after [StartBatch](#startbatch-method-zip-component).

After a batch is aborted, calling [ProcessBatch](#processbatch-method-zip-component) has no effect unless a new batch is started.

# AppendFiles Method ([Zip](#zip-component) Component)

Adds specified files to an existing archive.

## Syntax

*C++ Builder Syntax*

```text
void __fastcall AppendFiles();
```

## Remarks

All files contained in the Files collection will be appended to the archive specified by [ArchiveFile](#archivefile-property-zip-component).

When AppendFiles is called, only those files which are to be added to the archive must exist inside the collection. Note that if you call [Scan](#scan-method-zip-component) or [Extract](#extract-method-zip-component), you must empty the collection before adding files to the collection to be appended.

After the file is added, the collection will be updated appropriately.

This method may only be used to add files to an existing archive. To add files to a new archive, the [IncludeFiles](#includefiles-method-zip-component) and [Compress](#compress-method-zip-component) methods should be used.

**Example (Appending to an Archive)**

```text
string file_to_append = "C:\appendFile.txt";
ZipControl.ArchiveFile = "C:\archive.zip";
ZipControl.Files.Add(new ZIPFile("appendFile.txt", file_to_append));
ZipControl.AppendFiles();
```

# Compress Method ([Zip](#zip-component) Component)

Creates the compressed archive.

## Syntax

*C++ Builder Syntax*

```text
void __fastcall Compress();
```

## Remarks

Invoking Compress creates the archive specified by [ArchiveFile](#archivefile-property-zip-component). When the method is called, all files specified by the [FileDecompressedName](#filedecompressedname-property-zip-component) field of the Files collection will be compressed and written to [ArchiveFile](#archivefile-property-zip-component).

The compressed data may be streamed out by setting [WriteToProgressEvent](#WriteToProgressEvent) to true. If streaming is enabled the compressed data will also be provided via the [Progress](#progress-event-zip-component) event. If [ArchiveFile](#archivefile-property-zip-component) is set to an empty string the archive will be written only to this event.

The files to compress are specified in the Files collection. The file names are specified by [FileCompressedName](#filecompressedname-property-zip-component) and [FileDecompressedName](#filedecompressedname-property-zip-component). These should be specified before invoking Compress, either manually or by invoking [IncludeFiles](#includefiles-method-zip-component).

The [BeginFile](#beginfile-event-zip-component) and [EndFile](#endfile-event-zip-component) events will be fired as files are processed, and the [Progress](#progress-event-zip-component) event will be fired as data is compressed.

Existing files will be overwritten by the component if [OverwriteFiles](#overwritefiles-property-zip-component) is set to true. Finer control over which files are overwritten may be gained by trapping the [Overwrite](#overwrite-event-zip-component) event.

**Example (Creating an Archive)**

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

# Config Method ([Zip](#zip-component) Component)

Sets or retrieves a configuration setting.

## Syntax

*C++ Builder Syntax*

```text
String __fastcall Config(String ConfigurationString);
```

## Remarks

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

# Delete Method ([Zip](#zip-component) Component)

Deletes one or more files from an existing archive.

## Syntax

*C++ Builder Syntax*

```text
void __fastcall Delete(String FileNames);
```

## Remarks

Delete deletes one or more files from an existing archive, without reprocessing the compressed data. The archive will be opened immediately, and the file(s) will immediately be removed permanently from the archive.

The list of filenames should be specified exactly as when calling [Extract](#extract-method-zip-component):

*Filenames* may be set to one or more filenames or directory names. Files may be specified with or without a path, and with or without wildcards. If a path is specified, files in the indicated directory will be affected; subdirectories will be recursed into if [RecurseSubdirectories](#recursesubdirectories-property-zip-component) is true. If no path is specified but wildcards are, matching files in all directories will be affected. If a single filename without a path is specified, it must correspond exactly to the appropriate value of [FileCompressedName](#filecompressedname-property-zip-component).

Directories should end with a slash ("/"). If a directory is specified, all files and subdirectories in the specified directory will be affected.

A pipe character ("|") should be used to separate multiple file or directory names. Alternatively, the method may be invoked repeatedly.

The [ExcludedFiles](#excludedfiles-property-zip-component) property may be used to further limit the files to be deleted. When Delete is used to delete a directory or match wildcards, each file to be deleted is first compared against [ExcludedFiles](#excludedfiles-property-zip-component), and any files marked as excluded will not be deleted. When Delete is used to delete a single file, the value of [ExcludedFiles](#excludedfiles-property-zip-component) will be ignored.

When the method is invoked, the [Scan](#scan-method-zip-component) method will first be invoked, if it has not been invoked already. Note that if [IncludeFiles](#includefiles-method-zip-component) has been invoked, or if the values of [FileCompressedName](#filecompressedname-property-zip-component) and [FileDecompressedName](#filedecompressedname-property-zip-component) for each file in the Files collection have been set, this information will be reset by the call to [Scan](#scan-method-zip-component).

When deleting multiple files, the component will operate most efficiently if all filenames are passed to Delete in a single invocation of the method. Invoking Delete repeatedly on large archives is not recommended.

Invoking Delete will only remove files from [ArchiveFile](#archivefile-property-zip-component); it will not delete the files from the disk.

**Example**

```text
ZipControl.ArchiveFile = "c:\\test.zip"
ZipControl.Delete("default_readme.txt");
ZipControl.Append("\\mydir\\my_readme.txt", "my_readme.txt")
```

# Extract Method ([Zip](#zip-component) Component)

Extracts a single file, directory, or group of files, from the archive.

## Syntax

*C++ Builder Syntax*

```text
void __fastcall Extract(String FileNames);
```

## Remarks

Extract extracts one or more files from the archive. The file(s) will be extracted to the directory specified by [ExtractToPath](#extracttopath-property-zip-component), and given the names found in the archive or specified by the [FileDecompressedName](#filedecompressedname-property-zip-component) of the file in the Files collection.

*Filenames* may be set to one or more filenames or directory names. Files may be specified with or without a path, and with or without wildcards. If a path is specified, files in the indicated directory will be affected; subdirectories will be recursed into if [RecurseSubdirectories](#recursesubdirectories-property-zip-component) is true. If no path is specified but wildcards are, matching files in all directories will be affected. If a single filename without a path is specified, it must correspond exactly to the appropriate value of [FileCompressedName](#filecompressedname-property-zip-component).

Directories should end with a slash ("/"). If a directory is specified, all files and subdirectories in the specified directory will be affected.

A pipe character ("|") should be used to separate multiple file or directory names. Alternatively, the method may be invoked repeatedly.

The [ExcludedFiles](#excludedfiles-property-zip-component) property may be used to further limit the files to be extracted. When Extract is used to extract a directory or match wildcards, each file to be extracted is first compared against [ExcludedFiles](#excludedfiles-property-zip-component), and any files marked as excluded will not be extracted. When Extract is used to extract a single file, the value of [ExcludedFiles](#excludedfiles-property-zip-component) will be ignored.

To extract all files in the archive, the [ExtractAll](#extractall-method-zip-component) method may be used.

The [BeginFile](#beginfile-event-zip-component) and [EndFile](#endfile-event-zip-component) events will be fired before and after each file is extracted, and the [Progress](#progress-event-zip-component) 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 [Progress](#progress-event-zip-component) event.

**Example**

```text
ZipControl.ArchiveFile = "c:\test.tar"
ZipControl.ExcludedFiles = "*.bak | backup/"
ZipControl.ExtractToPath = "c:\temp"
ZipControl.Extract("*")
```

 **Example**

```text
ZipControl.ArchiveFile = "c:\test.zip"
ZipControl.ExcludedFiles = ""
ZipControl.ExtractToPath = "c:\temp"
ZipControl.Extract("code/")
```

 **Example**

```text
ZipControl.ArchiveFile = "c:\test.jar"
ZipControl.ExcludedFiles = "*.txt"
ZipControl.ExtractToPath = "c:\"
ZipControl.Extract("* | docs/readme.txt")
```

# ExtractAll Method ([Zip](#zip-component) Component)

Extracts all files from the compressed archive.

## Syntax

*C++ Builder Syntax*

```text
void __fastcall ExtractAll();
```

## Remarks

ExtractAll extracts all files from the archive. The file(s) will be extracted to the directory specified by [ExtractToPath](#extracttopath-property-zip-component), and given the names found in the archive or specified by the [FileDecompressedName](#filedecompressedname-property-zip-component) field of the file in the Files collection.

If [Scan](#scan-method-zip-component) has not been invoked when ExtractAll is called, [Scan](#scan-method-zip-component) will automatically be invoked, and the Files collection will be set to the values found in the archive. To manually set the decompressed filenames, [Scan](#scan-method-zip-component) should be invoked before setting the [FileDecompressedName](#filedecompressedname-property-zip-component) field.

Invoking this method is equivalent to setting [ExcludedFiles](#excludedfiles-property-zip-component) to the empty string, and then invoking [Extract](#extract-method-zip-component) with "*" as the argument. Calling this method will cause the [ExcludedFiles](#excludedfiles-property-zip-component) property to be ignored; to extract all files except those specified by [ExcludedFiles](#excludedfiles-property-zip-component), call the [Extract](#extract-method-zip-component) method with the wildcard "*" as the method parameter instead of calling this method.

The [BeginFile](#beginfile-event-zip-component) and [EndFile](#endfile-event-zip-component) events will be fired before and after each file is extracted, and the [Progress](#progress-event-zip-component) 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 [Progress](#progress-event-zip-component) event.

**Example (Extracting from an Archive)**

```text
ZipControl.ArchiveFile = "c:\temp.zip"
ZipControl.ExtractToPath = "c:\extracted\"
ZipControl.ExtractAll()
```

# IncludeFiles Method ([Zip](#zip-component) Component)

Specifies that the indicated files should be added to the archive.

## Syntax

*C++ Builder Syntax*

```text
void __fastcall IncludeFiles(String FileNames);
```

## Remarks

IncludeFiles may be used before [Compress](#compress-method-zip-component), to specify the files to be compressed. Invoking this method populates the Files collection accordingly.

Invoking the method does not create or alter the archive.

The argument should be a pipe ("|") -delimited sequence of one or more filenames. The filenames should be specified with paths if necessary, so that the files may be found on the local file system. The filenames will be stored as is in the [FileDecompressedName](#filedecompressedname-property-zip-component) field, and without a pathname in the [FileCompressedName](#filecompressedname-property-zip-component) field of the Files collection.

Filenames may include the wildcards '?', '*', and '[ .. ]'. '?' will match any single character, and '*' will match an arbitrary sequence of characters. '[ .. ]' may be used to match any of the characters inside, or a range, such as '[a-z]'. A '\' can be used to escape wildcard characters.

If wildcards are specified, the file system will be scanned and all files matching the specified mask will be added. Moreover, subdirectories will be recursed into if [RecurseSubdirectories](#recursesubdirectories-property-zip-component) is set to true. When recursing into subdirectories, relative path information will be stored in [FileCompressedName](#filecompressedname-property-zip-component) field of the Files collection.

The [ExcludedFiles](#excludedfiles-property-zip-component) may be used to limit the files to be compressed. This property is checked when [Compress](#compress-method-zip-component) is invoked, rather than when IncludeFiles is invoked, so this property may be set before or after invoking IncludeFiles.

Note that invoking IncludeFiles will not reset the component, or remove old values of [FileCompressedName](#filecompressedname-property-zip-component) and [FileDecompressedName](#filedecompressedname-property-zip-component). This may be done by first clearing the Files collection.

**Example**

```text
ZipControl.IncludeFiles("c:\test\* | c:\readme")
ZipControl.ExcludedFiles = "*.tmp"
ZipControl.Compress()
```

# ProcessBatch Method ([Zip](#zip-component) Component)

Processes the operations queued in the current batch.

## Syntax

*C++ Builder Syntax*

```text
void __fastcall ProcessBatch();
```

## Remarks

This method commits the pending operations recorded after [StartBatch](#startbatch-method-zip-component) to the archive in a single pass.

If no batch is active, or if no queued operation changed the working set, this method has no effect.

# Reset Method ([Zip](#zip-component) Component)

Resets the component.

## Syntax

*C++ Builder Syntax*

```text
void __fastcall Reset();
```

## Remarks

Reset resets the state of the component. The Files collection will be cleared, all properties will be set to their default values, and any files open will be closed.

# Scan Method ([Zip](#zip-component) Component)

Scans the compressed archive.

## Syntax

*C++ Builder Syntax*

```text
void __fastcall Scan();
```

## Remarks

This method will scan the archive specified by [ArchiveFile](#archivefile-property-zip-component). The number of files and their names and sizes will be determined and written to the Files collection.

After scanning the archive, the values of [FileDecompressedName](#filedecompressedname-property-zip-component) may be changed if desired, and any number of files may be decompressed. The [Extract](#extract-method-zip-component) method allows you to decompress files of your choice, and the [ExtractAll](#extractall-method-zip-component) method will decompress the entire archive.

Changing the values of the [FileCompressedName](#filecompressedname-property-zip-component) field or the number of files in the Files collection will invalidate the scan. If either of these is changed and [Extract](#extract-method-zip-component) or [ExtractAll](#extractall-method-zip-component) is then called; Scan will automatically be called again, and these values will be reset to their original values.

Calling this method will frequently generate a trappable error if the archive is corrupt. This is not guaranteed, however, as Scan only examines the headers.

**Example**

```text
Dim i As Integer
ZipControl.ArchiveFile = "c:\temp.zip"
ZipControl.Scan
For i = 0 To ZipControl.FileCount - 1
    Debug.Print "File Name: " & ZipControl.FileDecompressedName(i)
    Debug.Print "File Size: " & ZipControl.FileDecompressedSize(i)
Next i
```

# StartBatch Method ([Zip](#zip-component) Component)

Starts a batch session for queued archive updates.

## Syntax

*C++ Builder Syntax*

```text
void __fastcall StartBatch();
```

## Remarks

When this method is called, subsequent calls to [AppendFiles](#appendfiles-method-zip-component), [Delete](#delete-method-zip-component), and [Update](#update-method-zip-component) will update an in-memory working set instead of immediately rewriting the archive.

Use [ProcessBatch](#processbatch-method-zip-component) to commit the queued operations to the archive, or [AbortBatch](#abortbatch-method-zip-component) to discard them.

# Update Method ([Zip](#zip-component) Component)

Will update certain files in an archive.

## Syntax

*C++ Builder Syntax*

```text
void __fastcall Update(String FileNames);
```

## Remarks

When this method is called, the component will attempt to update files in the specified archive with the current files listed in the files collection. You may use the *FileNames* parameter to tell the component which files in the collection/archive must be updated.

*Filenames* may be set to one or more filenames or directory names. Files may be specified with or without a path, and with or without wildcards. If a path is specified, files in the indicated directory will be affected; subdirectories will be recursed into if [RecurseSubdirectories](#recursesubdirectories-property-zip-component) is true. If no path is specified but wildcards are, matching files in all directories will be affected. If a single filename without a path is specified, it must correspond exactly to the appropriate value of [FileCompressedName](#filecompressedname-property-zip-component).

Directories should end with a slash ("/"). If a directory is specified, all files and subdirectories in the specified directory will be affected.

A pipe character ("|") should be used to separate multiple file or directory names. Alternatively, the method may be invoked repeatedly.

# BeginFile Event ([Zip](#zip-component) Component)

Fired before each file is processed.

## Syntax

*C++ Builder Syntax*

```text
typedef struct {
  int Index;
  bool Skip;
} TipzZipBeginFileEventParams;
typedef void __fastcall (__closure *TipzZipBeginFileEvent)(System::TObject* Sender, TipzZipBeginFileEventParams *e);
__property TipzZipBeginFileEvent OnBeginFile = { read=FOnBeginFile, write=FOnBeginFile };
```

## Remarks

BeginFile is fired before each file is processed by the compressor or decompressor, as appropriate. *Index* contains the array index of the file about to be processed, and the [FileCompressedName](#filecompressedname-property-zip-component), [FileDecompressedName](#filedecompressedname-property-zip-component), [FileCompressedSize](#filecompressedsize-property-zip-component) (decompression only), and [FileDecompressedSize](#filedecompressedsize-property-zip-component) fields of the Files collection for this index contain more detailed information about the file about to be processed.

When extracting, an alternate location may be specified by trapping the event, and modifying [FileDecompressedName](#filedecompressedname-property-zip-component) and/or [ExtractToPath](#extracttopath-property-zip-component). If [FileDecompressedName](#filedecompressedname-property-zip-component) is set to an empty string, the file will not be written to disk. If [WriteToProgressEvent](#WriteToProgressEvent) is true, the file will still be decompressed, and the data may be extracted through the [Progress](#progress-event-zip-component) event.

This event may also be trapped while compressing. [FileCompressedName](#filecompressedname-property-zip-component) and [FileDecompressedName](#filedecompressedname-property-zip-component) may be changed.

 You may set the *Skip* parameter to true in order to skip the file completely while compressing or extracting.

# EndFile Event ([Zip](#zip-component) Component)

Fired after each file is processed.

## Syntax

*C++ Builder Syntax*

```text
typedef struct {
  int Index;
} TipzZipEndFileEventParams;
typedef void __fastcall (__closure *TipzZipEndFileEvent)(System::TObject* Sender, TipzZipEndFileEventParams *e);
__property TipzZipEndFileEvent OnEndFile = { read=FOnEndFile, write=FOnEndFile };
```

## Remarks

EndFile is fired after each file is processed by the compressor or decompressor, as appropriate. *Index* contains the array index of the file processed, and the [FileCompressedName](#filecompressedname-property-zip-component), [FileDecompressedName](#filedecompressedname-property-zip-component), [FileCompressedSize](#filecompressedsize-property-zip-component), and [FileDecompressedSize](#filedecompressedsize-property-zip-component) fields in the Files collection for this index contain more detailed information about the file processed.

# Error Event ([Zip](#zip-component) Component)

Information about non-fatal errors.

## Syntax

*C++ Builder Syntax*

```text
typedef struct {
  String Description;
  int ErrorCode;
  int Index;
  String FileName;
  bool Ignore;
} TipzZipErrorEventParams;
typedef void __fastcall (__closure *TipzZipErrorEvent)(System::TObject* Sender, TipzZipErrorEventParams *e);
__property TipzZipErrorEvent OnError = { read=FOnError, write=FOnError };
```

## 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 ([Zip](#zip-component) Component)

Fired whenever a file exists and may be overwritten.

## Syntax

*C++ Builder Syntax*

```text
typedef struct {
  String FileName;
  bool Overwrite;
} TipzZipOverwriteEventParams;
typedef void __fastcall (__closure *TipzZipOverwriteEvent)(System::TObject* Sender, TipzZipOverwriteEventParams *e);
__property TipzZipOverwriteEvent OnOverwrite = { read=FOnOverwrite, write=FOnOverwrite };
```

## 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](#overwritefiles-property-zip-component) 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.

# Password Event ([Zip](#zip-component) Component)

Fired when a file is encrypted, and the file's password is incorrect.

## Syntax

*C++ Builder Syntax*

```text
typedef struct {
  int Index;
  String Password;
} TipzZipPasswordEventParams;
typedef void __fastcall (__closure *TipzZipPasswordEvent)(System::TObject* Sender, TipzZipPasswordEventParams *e);
__property TipzZipPasswordEvent OnPassword = { read=FOnPassword, write=FOnPassword };
```

## Remarks

This event is fired when the component attempts to uncompress an encrypted file and the decryption fails due to an invalid password. The file may be identified in the collection by the *Index* parameter.

Setting the *Password* parameter in this event will cause the component to attempt to decrypt and decompress the file again with the specified password.

If the *Password* parameter is an empty string when this event completes, an error will occur.

# Progress Event ([Zip](#zip-component) Component)

Fired as progress is made.

## Syntax

*C++ Builder Syntax*

```text
typedef struct {
  String Data;
  DynamicArray<Byte> DataB;
  String FileName;
  __int64 BytesProcessed;
  int PercentProcessed;
} TipzZipProgressEventParams;
typedef void __fastcall (__closure *TipzZipProgressEvent)(System::TObject* Sender, TipzZipProgressEventParams *e);
__property TipzZipProgressEvent OnProgress = { read=FOnProgress, write=FOnProgress };
```

## 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 ([Zip](#zip-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-zip-component) method.

### Zip Config Settings

**AESGenerateUniqueKeys**: Whether to generate unique keys for each file encrypted.This setting controls the algorithm that generates AES cryptographic keys from the [Password](#password-property-zip-component) specified. For added security, a random *salt* value is generated, and a unique key will be generated for every unique combination of [Password](#password-property-zip-component) and salt.

If true, a unique salt value and key will be generated for each file encrypted. If false, a single salt value and key will be generated for all encrypted files in the archive.

If you are encrypting a lot of files, the value of this setting can have a substantial effect on both security and performance. By default, the component will set this to false.

**CheckForFileLocks**: If true, the component requests an exclusive lock during initialization.If set to true, the component will request an exclusive lock during initialization to ensure there are no other processes locking a file. This is a temporary lock and is released before work is done. This is especially useful when another process has a partial lock on a file, for instance when Outlook is working with a .pst.

False by default.

**CompressionMethod**: Used to set the method of compression.This is used to specify different compression methods. By default the component uses the Deflate compression method (a value of 0). Supported values are:

|  |  |
| --- | --- |
| Value | Method |
| 0 | Deflate (default) |
| 1 | PPMd |

**EnableStreamingEncryption**: Whether to allow streaming and encryption simultaneously.If true, the component will allow encrypted files to be streamed out during compression; i.e., the component will allow you to compress with [WriteToProgressEvent](#WriteToProgressEvent) set to true and a [Password](#password-property-zip-component) has been set.

Use extreme caution when setting this option, as streamed and encrypted zip files may be unreadable by other zip software.

**ExcludedAttributes**: Attributes of files to be excluded. Files with attributes matching those specified will be excluded from compression or decompression. May be set to any combination of *H* (hidden), *S* (system), *A* (archive), and *R* (read-only). (Example: "HSR") Alternatively, may be set to a bitmask of the following flags: Readonly (1), Hidden (2), System (4), Directory (16), Archive (32).

For **Java**, when compressing, attributes other than "H" and "R" will be ignored (due to JRE limitations).

*Default:* "" (no excluded attributes)

**ExtractFilesOnly**: Whether to only extract the files contained within the archive. If true, only the files contained within the [ArchiveFile](#archivefile-property-zip-component) are extracted directly to the specified [ExtractToPath](#extracttopath-property-zip-component). Folders contained within the [ArchiveFile](#archivefile-property-zip-component) will not be created within the [ExtractToPath](#extracttopath-property-zip-component). If an archive contains files with the same name, you can control whether or not they get overwritten by setting [OverwriteFiles](#overwritefiles-property-zip-component).

**FileHashAlgorithm**: The algorithm to use when computing the file hash.This setting specifies the algorithm (if any) to use when computing the hash for files within the archive. If specified, when [Compress](#compress-method-zip-component) is called the hash will be computed for each file within the archive and [FileHash](#filehash-property-zip-component) will be populated with the computed hash value. Possible values are:

- "" (Default - no hash is computed)
- "SHA1"
- "SHA224"
- "SHA256"
- "SHA284"
- "MD5"

**FileNamesCaseSensitive**: This config controls the case-sensitivity of the component when working with filenames.Set this to a value from below to control whether the component is case-sensitive when working with filenames.

|  |  |
| --- | --- |
| 0 | Case-Insensitive |
| 1 | Case-Sensitive |
| 2 | Automatic (Default) |

The default behavior is *Automatic*. The component will use the system behavior.

**ForceZip64Format**: Whether to explicitly compress a Zip64 format archive.Setting this value to true will force the component to always create a Zip64 format archive when compressing. By default, this value is false and the component will detect whether or not compressing in Zip64 format is necessary.

**MarkAsText**: Whether to mark files as text files. If true, the component will mark files as text within the zip archive. This may allow decompression software on other platforms to translate between character sets, etc.

If false (the default), files will be written as binary. To mark some files as text and others as binary, it is recommended that you trap the [BeginFile](#beginfile-event-zip-component) event and set this property value as appropriate for each file.

**OverwriteReadonlyFiles**: Whether to overwrite readonly files. If true, the component will overwrite readonly files when decompressing. If false (the default), the component will fire the [Error](#error-event-zip-component) event, instead, and will fail with an exception if the error is not trapped and explicitly ignored in the event.

**PreserveModifiedTime**: Whether or not to preserve the original modified time on extracted files.Specifies whether or not the modified time of the extracted files use the current time or the original time of the file in the archive.

When set to True (default) the extracted files will have the same modified time as the original file.

When set to False the modified time on the extracted files will be set to the current time.

**RecalculateCRC**: Whether to recalculate the CRC.If True, the component will recalculate the CRC whenever data from the file is added to the archive. In situations where file content may be changing during compression this will ensure a correct CRC.

Use this setting with caution as it can impact performance. The default value is False.

**TempPath**: Specifies the directory path where temporary files are written.This config specifies the path to a directory where the component may write temporary files. During certain operations, the component may need to create temporary files on disk to support the current process.

By default, this config is an empty string, and temporary files will be created in the systems default temporary directory (e.g., */tmp* on Linux, or *%TEMP%* on Windows). When this config is specified, temporary files will instead be created in the provided directory path instead.

**UseIBM437ASDefaultEncoding**: Whether or not to use the IBM437 default encoding.Specifies whether the default IBM437 or UTF-8 encoding should be used.

By default, this config is set to true.

**VerifyPassword**: Check whether the specified Password can decrypt the archive without extracting files.If the password set in the [Password](#password-property-zip-component) property can successfully decrypt the archive, this config will return the string "True". Otherwise, it will return the string "False". No files are extracted when this config is referenced.

For example:

```text
Zip zip = new Zip();
zip.ArchiveFile = myArchive;
zip.Password = myPassword;
string verified = zip.Config("VerifyPassword");
// verified contains either "True" or "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-zip-component), [ExtractAll](#extractall-method-zip-component), and [Compress](#compress-method-zip-component) will be written to the [Progress](#progress-event-zip-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-zip-component) event will contain null.

Note that if streaming is enabled the zip files written will be slightly larger. Moreover, zip files produced with [WriteToProgressEvent](#WriteToProgressEvent) may be incompatible with certain older zip utilities.

By default, [Password](#password-property-zip-component) encryption is not allowed for archives created with [WriteToProgressEvent](#WriteToProgressEvent) set to true. You may set the [EnableStreamingEncryption](#EnableStreamingEncryption) setting to allow this, but streamed and encrypted zip files may be incompatible with other utilities.

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

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

 This setting is set to *false* by default on all platforms.

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

### Zip Errors

|  |  |
| --- | --- |
| 101 | The zip archive is of an invalid or unsupported format. |
| 105 | The password is missing or incorrect. |
| 106 | Encryption is not supported when streaming is enabled. |
| 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). |