Zip Class

Properties Methods Events Config Settings Errors

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

Syntax

Zip

Remarks

The class 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 property to the name of the archive to be created. Then, specify the files to be compressed either by invoking IncludeFiles, or by adding a new object to the Files collection and setting the values of the FileDecompressedName and FileCompressedName. fields. Finally, call the Compress method to create the archive.

To decompress an existing archive, set ArchiveFile to the name of the archive to be decompressed. The ExtractToPath property may be set, and then calling the ExtractAll method will decompress all files in the archive to this path.

For finer control, the Scan 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 may then be changed if desired. Finally, ExtractAll may be used to decompress the entire archive, or Extract may be used for finer control.

Data may be streamed out by setting WriteToProgressEvent to true. Then, the Progress event may be trapped to retrieve the data.

Example (Creating an Archive)

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

Example (Extracting from an Archive)

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

Property List

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


ArchiveFile	The name of the zip, gzip, tar, or jar archive.
CompressionLevel	The compression level to use.
CompressionMethod	The compression method to use.
EncryptionAlgorithm	The algorithm used to encrypt files written to the archive.
ExcludedFiles	A list of files to exclude.
ExtractToPath	A base path to decompress to.
FileCount	The number of records in the File arrays.
FileAttributes	The attributes of the files to be compressed or decompressed.
FileComment	Specifies a comment for the entry in the zip file.
FileCompressedDate	The date and time of the entry, as stored within the archive.
FileCompressedName	The file name of the current file, as stored inside of the archive.
FileCompressedSize	The size of the compressed data, as compressed within the archive.
FileCompressionLevel	The compression level to use for the file.
FileCRC	The CRC value for the specified file found in the archive.
FileDecompressedName	The name of the file in the archive, as stored on the file system, outside the archive.
FileDecompressedSize	The size of the file, as decompressed outside the archive.
FileEncryptionAlgorithm	The algorithm used to encrypt the specified file written to the archive.
FileHash	The computed hash for the specified File.
FileInputData	When This property is set, the class will read in the data from This property instead of reading from the file contained in the DecompressedName property.
FileInputStream	When this property is set to a valid stream, the class will read in the data from the stream as the current file instead of reading from the file contained in the DecompressedName property.
FilePassword	This property specifies the case-sensitive password used to encrypt or decrypt the current file.
FilePasswordRequired	This property describes whether or not the current file has been encrypted or not and requires a password to decompress.
OverwriteFiles	Whether or not to overwrite files.
Password	A password for the zip archive.
RecurseSubdirectories	Whether or not to recurse into subdirectories.
ZipComment	The comment for the entire zip file.
ZipData	(Decompression only) The zip file contents as a byte array.

Method List

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


Abort	Aborts the current operation.
AppendFiles	Adds specified files to an existing archive.
Compress	Creates the compressed archive.
Config	Sets or retrieves a configuration setting.
Delete	Deletes one or more files from an existing archive.
Extract	Extracts a single file, directory, or group of files, from the archive.
ExtractAll	Extracts all files from the compressed archive.
IncludeFiles	Specifies that the indicated files should be added to the archive.
Reset	Resets the class.
Scan	Scans the compressed archive.
SetArchiveInputStream	The stream to read the zip, tar, jar, or gzip archive from.
SetArchiveOutputStream	The stream to write the zip, tar, jar, or gzip archive to.
Update	Will update certain files in an archive.

Event List

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


BeginFile	Fired before each file is processed.
EndFile	Fired after each file is processed.
Error	Information about non-fatal errors.
Overwrite	Fired whenever a file exists and may be overwritten.
Password	Fired when a file is encrypted, and the file's password is incorrect.
Progress	Fired as progress is made.

Config Settings

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


AESGenerateUniqueKeys	Whether to generate unique keys for each file encrypted.
CheckForFileLocks	If true, the class requests an exclusive lock during initialization.
CompressionMethod	Used to set the method of compression.
EnableStreamingEncryption	Whether to allow streaming and encryption simultaneously.
ExcludedAttributes	Attributes of files to be excluded.
ExtractFilesOnly	Whether to only extract the files contained within the archive.
FileHashAlgorithm	The algorithm to use when computing the file hash.
ForceZip64Format	Whether to explicitly compress a Zip64 format archive.
MarkAsText	Whether to mark files as text files.
OverwriteReadonlyFiles	Whether to overwrite readonly files.
PreserveModifiedTime	Whether or not to preserve the original modified time on extracted files.
RecalculateCRC	Whether to recalculate the CRC.
UseIBM437ASDefaultEncoding	Whether or not to use the IBM437 default encoding.
VerifyPassword	Check whether the specified Password can decrypt the archive without extracting files.
WriteToProgressEvent	Whether or not to write data to the Progress Event.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.

ArchiveFile Property (Zip Class)

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

Syntax

ANSI (Cross Platform)
char* GetArchiveFile();
int SetArchiveFile(const char* lpszArchiveFile);

Unicode (Windows)
LPWSTR GetArchiveFile();
INT SetArchiveFile(LPCWSTR lpszArchiveFile);

char* ipworkszip_zip_getarchivefile(void* lpObj);
int ipworkszip_zip_setarchivefile(void* lpObj, const char* lpszArchiveFile);

QString GetArchiveFile();
int SetArchiveFile(QString qsArchiveFile);

Default Value

Remarks

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

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

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

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

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

Example (Creating an Archive)

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

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

Data Type

String

CompressionLevel Property (Zip Class)

The compression level to use.

Syntax

ANSI (Cross Platform)
int GetCompressionLevel();
int SetCompressionLevel(int iCompressionLevel);

Unicode (Windows)
INT GetCompressionLevel();
INT SetCompressionLevel(INT iCompressionLevel);

int ipworkszip_zip_getcompressionlevel(void* lpObj);
int ipworkszip_zip_setcompressionlevel(void* lpObj, int iCompressionLevel);

int GetCompressionLevel();
int SetCompressionLevel(int iCompressionLevel);

Default Value

Remarks

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

Set the level of CompressionLevel in the BeginFile event to apply different levels of compression to different files.

Data Type

Integer

CompressionMethod Property (Zip Class)

The compression method to use.

Syntax

ANSI (Cross Platform)
int GetCompressionMethod();
int SetCompressionMethod(int iCompressionMethod);

Unicode (Windows)
INT GetCompressionMethod();
INT SetCompressionMethod(INT iCompressionMethod);

Possible Values

CM_DEFLATE(0), 
CM_PPMD(1), 
CM_BZIP_2(2)

int ipworkszip_zip_getcompressionmethod(void* lpObj);
int ipworkszip_zip_setcompressionmethod(void* lpObj, int iCompressionMethod);

int GetCompressionMethod();
int SetCompressionMethod(int iCompressionMethod);

Default Value

Remarks

This property specifies the compression method to use. By default the class 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 Class)

The algorithm used to encrypt files written to the archive.

Syntax

ANSI (Cross Platform)
int GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(int iEncryptionAlgorithm);

Unicode (Windows)
INT GetEncryptionAlgorithm();
INT SetEncryptionAlgorithm(INT iEncryptionAlgorithm);

Possible Values

EA_DEFAULT(0), 
EA_AESWEAK(1), 
EA_AESSTRONG(2), 
EA_AESMAXIMUM(3)

int ipworkszip_zip_getencryptionalgorithm(void* lpObj);
int ipworkszip_zip_setencryptionalgorithm(void* lpObj, int iEncryptionAlgorithm);

int GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(int iEncryptionAlgorithm);

Default Value

Remarks

The algorithm used to encrypt files written to the archive.

Note that files will only be encrypted if Password is set. By default the class will use standard zip encryption if Password is set, and will not encrypt data otherwise.

The class 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 class may or may not be compatible with other Zip utilities.

The class 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 class will generate a unique salt value and cryptographic key for each file encrypted. If you use weak encryption the class 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. 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 Class)

A list of files to exclude.

Syntax

ANSI (Cross Platform)
char* GetExcludedFiles();
int SetExcludedFiles(const char* lpszExcludedFiles);

Unicode (Windows)
LPWSTR GetExcludedFiles();
INT SetExcludedFiles(LPCWSTR lpszExcludedFiles);

char* ipworkszip_zip_getexcludedfiles(void* lpObj);
int ipworkszip_zip_setexcludedfiles(void* lpObj, const char* lpszExcludedFiles);

QString GetExcludedFiles();
int SetExcludedFiles(QString qsExcludedFiles);

Default Value

Remarks

This property specifies files that should be excluded when Compress or Extract is invoked. When Compress is invoked, each value of FileDecompressedName in Files will be compared to ExcludedFiles, and each file will be excluded if the name matches. When Extract is called, each value of FileCompressedName in Files matching the parameter to Extract will be compared to ExcludedFiles, and will be excluded if appropriate. Calling the ExtractAll 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 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 or FileDecompressedName.

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

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

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, the format of ExcludedFiles should correspond to that of the local file system. When invoking Extract 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 class for both compression and extraction. Failure to do so may result in I/O errors or unexpected results.

Data Type

String

ExtractToPath Property (Zip Class)

A base path to decompress to.

Syntax

ANSI (Cross Platform)
char* GetExtractToPath();
int SetExtractToPath(const char* lpszExtractToPath);

Unicode (Windows)
LPWSTR GetExtractToPath();
INT SetExtractToPath(LPCWSTR lpszExtractToPath);

char* ipworkszip_zip_getextracttopath(void* lpObj);
int ipworkszip_zip_setextracttopath(void* lpObj, const char* lpszExtractToPath);

QString GetExtractToPath();
int SetExtractToPath(QString qsExtractToPath);

Default Value

Remarks

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

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

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

Example (Extracting from an Archive)

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

Example - Adding Files 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 Class)

The number of records in the File arrays.

Syntax

ANSI (Cross Platform)
int GetFileCount();
int SetFileCount(int iFileCount);

Unicode (Windows)
INT GetFileCount();
INT SetFileCount(INT iFileCount);

int ipworkszip_zip_getfilecount(void* lpObj);
int ipworkszip_zip_setfilecount(void* lpObj, int iFileCount);

int GetFileCount();
int SetFileCount(int iFileCount);

Default Value

Remarks

This property controls the size of the following arrays:

FileAttributes
FileComment
FileCompressedDate
FileCompressedName
FileCompressedSize
FileCompressionLevel
FileCRC
FileDecompressedName
FileDecompressedSize
FileEncryptionAlgorithm
FileHash
FileInputData
FileInputStream
FilePassword
FilePasswordRequired

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 Class)

The attributes of the files to be compressed or decompressed.

Syntax

ANSI (Cross Platform)
int GetFileAttributes(int iFileIndex);
int SetFileAttributes(int iFileIndex, int iFileAttributes);

Unicode (Windows)
INT GetFileAttributes(INT iFileIndex);
INT SetFileAttributes(INT iFileIndex, INT iFileAttributes);

int ipworkszip_zip_getfileattributes(void* lpObj, int fileindex);
int ipworkszip_zip_setfileattributes(void* lpObj, int fileindex, int iFileAttributes);

int GetFileAttributes(int iFileIndex);
int SetFileAttributes(int iFileIndex, int iFileAttributes);

Default Value

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

This property is not available at design time.

Data Type

Integer

FileComment Property (Zip Class)

Specifies a comment for the entry in the zip file.

Syntax

ANSI (Cross Platform)
char* GetFileComment(int iFileIndex);
int SetFileComment(int iFileIndex, const char* lpszFileComment);

Unicode (Windows)
LPWSTR GetFileComment(INT iFileIndex);
INT SetFileComment(INT iFileIndex, LPCWSTR lpszFileComment);

char* ipworkszip_zip_getfilecomment(void* lpObj, int fileindex);
int ipworkszip_zip_setfilecomment(void* lpObj, int fileindex, const char* lpszFileComment);

QString GetFileComment(int iFileIndex);
int SetFileComment(int iFileIndex, QString qsFileComment);

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

This property is not available at design time.

Data Type

String

FileCompressedDate Property (Zip Class)

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

Syntax

ANSI (Cross Platform)
int64 GetFileCompressedDate(int iFileIndex);
int SetFileCompressedDate(int iFileIndex, int64 lFileCompressedDate);

Unicode (Windows)
LONG64 GetFileCompressedDate(INT iFileIndex);
INT SetFileCompressedDate(INT iFileIndex, LONG64 lFileCompressedDate);

int64 ipworkszip_zip_getfilecompresseddate(void* lpObj, int fileindex);
int ipworkszip_zip_setfilecompresseddate(void* lpObj, int fileindex, int64 lFileCompressedDate);

qint64 GetFileCompressedDate(int iFileIndex);
int SetFileCompressedDate(int iFileIndex, qint64 lFileCompressedDate);

Default Value

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

This property is not available at design time.

Data Type

Long64

FileCompressedName Property (Zip Class)

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

Syntax

ANSI (Cross Platform)
char* GetFileCompressedName(int iFileIndex);
int SetFileCompressedName(int iFileIndex, const char* lpszFileCompressedName);

Unicode (Windows)
LPWSTR GetFileCompressedName(INT iFileIndex);
INT SetFileCompressedName(INT iFileIndex, LPCWSTR lpszFileCompressedName);

char* ipworkszip_zip_getfilecompressedname(void* lpObj, int fileindex);
int ipworkszip_zip_setfilecompressedname(void* lpObj, int fileindex, const char* lpszFileCompressedName);

QString GetFileCompressedName(int iFileIndex);
int SetFileCompressedName(int iFileIndex, QString qsFileCompressedName);

Default Value

Remarks

The file name of the current file, as stored inside of the archive. This may be the same as in FileDecompressedName, 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 class, 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

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

This property is not available at design time.

Data Type

String

FileCompressedSize Property (Zip Class)

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

Syntax

ANSI (Cross Platform)
int64 GetFileCompressedSize(int iFileIndex);

Unicode (Windows)
LONG64 GetFileCompressedSize(INT iFileIndex);

int64 ipworkszip_zip_getfilecompressedsize(void* lpObj, int fileindex);

qint64 GetFileCompressedSize(int iFileIndex);

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, or 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 property.

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

Data Type

Long64

FileCompressionLevel Property (Zip Class)

The compression level to use for the file.

Syntax

ANSI (Cross Platform)
int GetFileCompressionLevel(int iFileIndex);
int SetFileCompressionLevel(int iFileIndex, int iFileCompressionLevel);

Unicode (Windows)
INT GetFileCompressionLevel(INT iFileIndex);
INT SetFileCompressionLevel(INT iFileIndex, INT iFileCompressionLevel);

int ipworkszip_zip_getfilecompressionlevel(void* lpObj, int fileindex);
int ipworkszip_zip_setfilecompressionlevel(void* lpObj, int fileindex, int iFileCompressionLevel);

int GetFileCompressionLevel(int iFileIndex);
int SetFileCompressionLevel(int iFileIndex, int iFileCompressionLevel);

Default Value

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 class to compress better; lower values will cause the class 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 property.

This property is not available at design time.

Data Type

Integer

FileCRC Property (Zip Class)

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

Syntax

ANSI (Cross Platform)
int64 GetFileCRC(int iFileIndex);

Unicode (Windows)
LONG64 GetFileCRC(INT iFileIndex);

int64 ipworkszip_zip_getfilecrc(void* lpObj, int fileindex);

qint64 GetFileCRC(int iFileIndex);

Default Value

Remarks

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

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

Data Type

Long64

FileDecompressedName Property (Zip Class)

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

Syntax

ANSI (Cross Platform)
char* GetFileDecompressedName(int iFileIndex);
int SetFileDecompressedName(int iFileIndex, const char* lpszFileDecompressedName);

Unicode (Windows)
LPWSTR GetFileDecompressedName(INT iFileIndex);
INT SetFileDecompressedName(INT iFileIndex, LPCWSTR lpszFileDecompressedName);

char* ipworkszip_zip_getfiledecompressedname(void* lpObj, int fileindex);
int ipworkszip_zip_setfiledecompressedname(void* lpObj, int fileindex, const char* lpszFileDecompressedName);

QString GetFileDecompressedName(int iFileIndex);
int SetFileDecompressedName(int iFileIndex, QString qsFileDecompressedName);

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

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

This property is not available at design time.

Data Type

String

FileDecompressedSize Property (Zip Class)

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

Syntax

ANSI (Cross Platform)
int64 GetFileDecompressedSize(int iFileIndex);

Unicode (Windows)
LONG64 GetFileDecompressedSize(INT iFileIndex);

int64 ipworkszip_zip_getfiledecompressedsize(void* lpObj, int fileindex);

qint64 GetFileDecompressedSize(int iFileIndex);

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 class will retrieve the information for the corresponding value of FileDecompressedName 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 property.

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

Data Type

Long64

FileEncryptionAlgorithm Property (Zip Class)

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

Syntax

ANSI (Cross Platform)
int GetFileEncryptionAlgorithm(int iFileIndex);
int SetFileEncryptionAlgorithm(int iFileIndex, int iFileEncryptionAlgorithm);

Unicode (Windows)
INT GetFileEncryptionAlgorithm(INT iFileIndex);
INT SetFileEncryptionAlgorithm(INT iFileIndex, INT iFileEncryptionAlgorithm);

Possible Values

EA_DEFAULT(0), 
EA_AESWEAK(1), 
EA_AESSTRONG(2), 
EA_AESMAXIMUM(3)

int ipworkszip_zip_getfileencryptionalgorithm(void* lpObj, int fileindex);
int ipworkszip_zip_setfileencryptionalgorithm(void* lpObj, int fileindex, int iFileEncryptionAlgorithm);

int GetFileEncryptionAlgorithm(int iFileIndex);
int SetFileEncryptionAlgorithm(int iFileIndex, int iFileEncryptionAlgorithm);

Default Value

Remarks

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

Note that the file will only be encrypted if FilePassword is set. By default the class will use standard zip encryption if FilePassword is set, and will not encrypt data otherwise.

The class 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 using AES encryption it is important to choose a good FilePassword. For 128-bit keys it is recommended that your password be 32 characters long, and for 256-bit keys, 64 characters.

To set the FileEncryptionAlgorithm or FilePassword properties for the entire archive, use the EncryptionAlgorithm or Password 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 property.

This property is not available at design time.

Data Type

Integer

FileHash Property (Zip Class)

The computed hash for the specified File.

Syntax

ANSI (Cross Platform)
char* GetFileHash(int iFileIndex);

Unicode (Windows)
LPWSTR GetFileHash(INT iFileIndex);

char* ipworkszip_zip_getfilehash(void* lpObj, int fileindex);

QString GetFileHash(int iFileIndex);

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. This property is only applicable if the 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 property.

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

Data Type

String

FileInputData Property (Zip Class)

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

Syntax

ANSI (Cross Platform)
int GetFileInputData(int iFileIndex, char* &lpFileInputData, int &lenFileInputData);
int SetFileInputData(int iFileIndex, const char* lpFileInputData, int lenFileInputData);

Unicode (Windows)
INT GetFileInputData(INT iFileIndex, LPSTR &lpFileInputData, INT &lenFileInputData);
INT SetFileInputData(INT iFileIndex, LPCSTR lpFileInputData, INT lenFileInputData);

int ipworkszip_zip_getfileinputdata(void* lpObj, int fileindex, char** lpFileInputData, int* lenFileInputData);
int ipworkszip_zip_setfileinputdata(void* lpObj, int fileindex, const char* lpFileInputData, int lenFileInputData);

QByteArray GetFileInputData(int iFileIndex);
int SetFileInputData(int iFileIndex, QByteArray qbaFileInputData);

Default Value

Remarks

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

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

Binary String

FileInputStream Property (Zip Class)

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

Syntax

ANSI (Cross Platform)
int SetFileInputStream(int iFileIndex, IPWorksZipStream* sFileInputStream);

Unicode (Windows)
INT SetFileInputStream(INT iFileIndex, IPWorksZipStream* sFileInputStream);

int ipworkszip_zip_setfileinputstream(void* lpObj, int fileindex, IPWorksZipStream* sFileInputStream);

int SetFileInputStream(int iFileIndex, IPWorksZipStream* sFileInputStream);

Remarks

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

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

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

Data Type

IPWorksZipStream

FilePassword Property (Zip Class)

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

Syntax

ANSI (Cross Platform)
char* GetFilePassword(int iFileIndex);
int SetFilePassword(int iFileIndex, const char* lpszFilePassword);

Unicode (Windows)
LPWSTR GetFilePassword(INT iFileIndex);
INT SetFilePassword(INT iFileIndex, LPCWSTR lpszFilePassword);

char* ipworkszip_zip_getfilepassword(void* lpObj, int fileindex);
int ipworkszip_zip_setfilepassword(void* lpObj, int fileindex, const char* lpszFilePassword);

QString GetFilePassword(int iFileIndex);
int SetFilePassword(int iFileIndex, QString qsFilePassword);

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 property instead of the Password property of the Files collection. You may also use FilePasswordRequired 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 must be set to false if Password is set.

Example (Compressing an Archive)

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

This property is not available at design time.

Data Type

String

FilePasswordRequired Property (Zip Class)

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

Syntax

ANSI (Cross Platform)
int GetFilePasswordRequired(int iFileIndex);

Unicode (Windows)
BOOL GetFilePasswordRequired(INT iFileIndex);

int ipworkszip_zip_getfilepasswordrequired(void* lpObj, int fileindex);

bool GetFilePasswordRequired(int iFileIndex);

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

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

Data Type

Boolean

OverwriteFiles Property (Zip Class)

Whether or not to overwrite files.

Syntax

ANSI (Cross Platform)
int GetOverwriteFiles();
int SetOverwriteFiles(int bOverwriteFiles);

Unicode (Windows)
BOOL GetOverwriteFiles();
INT SetOverwriteFiles(BOOL bOverwriteFiles);

int ipworkszip_zip_getoverwritefiles(void* lpObj);
int ipworkszip_zip_setoverwritefiles(void* lpObj, int bOverwriteFiles);

bool GetOverwriteFiles();
int SetOverwriteFiles(bool bOverwriteFiles);

Default Value

TRUE

Remarks

If this property is set to true, existing files will be overwritten when decompressing. When Extract or ExtractAll is called, each file specified in Files will be checked for existence. If a file exists, the Overwrite 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 event and altering its parameters when the event is fired.

This property only affects the operation of Extract and ExtractAll. When compressing files, ArchiveFile will always be overwritten unless the user specifies otherwise in the Overwrite event.

Data Type

Boolean

Password Property (Zip Class)

A password for the zip archive.

Syntax

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* ipworkszip_zip_getpassword(void* lpObj);
int ipworkszip_zip_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

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.

In this release, streaming out of encrypted archives is not supported. When compressing, WriteToProgressEvent must be set to false if Password is set.

Example (Compressing an Archive)

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

Data Type

String

RecurseSubdirectories Property (Zip Class)

Whether or not to recurse into subdirectories.

Syntax

ANSI (Cross Platform)
int GetRecurseSubdirectories();
int SetRecurseSubdirectories(int bRecurseSubdirectories);

Unicode (Windows)
BOOL GetRecurseSubdirectories();
INT SetRecurseSubdirectories(BOOL bRecurseSubdirectories);

int ipworkszip_zip_getrecursesubdirectories(void* lpObj);
int ipworkszip_zip_setrecursesubdirectories(void* lpObj, int bRecurseSubdirectories);

bool GetRecurseSubdirectories();
int SetRecurseSubdirectories(bool bRecurseSubdirectories);

Default Value

TRUE

Remarks

This property affects the behavior of IncludeFiles and Extract and the meaning of ExcludedFiles. If this property is set to true, IncludeFiles 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, Extract, or Compress; changing the value of this property after method calls will not retroactively alter their effects.

Example (Creating an Archive)

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

Data Type

Boolean

ZipComment Property (Zip Class)

The comment for the entire zip file.

Syntax

ANSI (Cross Platform)
char* GetZipComment();
int SetZipComment(const char* lpszZipComment);

Unicode (Windows)
LPWSTR GetZipComment();
INT SetZipComment(LPCWSTR lpszZipComment);

char* ipworkszip_zip_getzipcomment(void* lpObj);
int ipworkszip_zip_setzipcomment(void* lpObj, const char* lpszZipComment);

QString GetZipComment();
int SetZipComment(QString qsZipComment);

Default Value

Remarks

Specifies a global comment for the zip file. Set this property before invoking Compress to include a comment in the zip file. Read it after invoking Scan to read the zip comment.

Data Type

String

ZipData Property (Zip Class)

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

Syntax

ANSI (Cross Platform)
int GetZipData(char* &lpZipData, int &lenZipData);
int SetZipData(const char* lpZipData, int lenZipData);

Unicode (Windows)
INT GetZipData(LPSTR &lpZipData, INT &lenZipData);
INT SetZipData(LPCSTR lpZipData, INT lenZipData);

int ipworkszip_zip_getzipdata(void* lpObj, char** lpZipData, int* lenZipData);
int ipworkszip_zip_setzipdata(void* lpObj, const char* lpZipData, int lenZipData);

QByteArray GetZipData();
int SetZipData(QByteArray qbaZipData);

Default Value

Remarks

Normally you should set ArchiveFile before invoking Scan or Extract. 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 to true, and after invoking Scan, you should set the value of FileDecompressedName for each file in the Files collection to an empty string. Then, when you invoke Extract (or ExtractAll) the data will be provided in the Progress event.

This property is write-only. Note that modifying a zip file stored in ZipData is not supported, so Append, Delete, etc., will throw exceptions.

This property is not available at design time.

Data Type

Binary String

Abort Method (Zip Class)

Aborts the current operation.

Syntax

ANSI (Cross Platform)
int Abort();

Unicode (Windows)
INT Abort();

int ipworkszip_zip_abort(void* lpObj);

int Abort();

Remarks

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

In case Append or Delete is aborted the archive will be left in its original state.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AppendFiles Method (Zip Class)

Adds specified files to an existing archive.

Syntax

ANSI (Cross Platform)
int AppendFiles();

Unicode (Windows)
INT AppendFiles();

int ipworkszip_zip_appendfiles(void* lpObj);

int AppendFiles();

Remarks

All files contained in the Files collection will be appended to the archive specified by ArchiveFile.

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 or Extract, 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 and Compress methods should be used.

Error Handling (C++)

Compress Method (Zip Class)

Creates the compressed archive.

Syntax

ANSI (Cross Platform)
int Compress();

Unicode (Windows)
INT Compress();

int ipworkszip_zip_compress(void* lpObj);

int Compress();

Remarks

Invoking Compress creates the archive specified by ArchiveFile. When the method is called, all files specified by the FileDecompressedName field of the Files collection will be compressed and written to ArchiveFile.

The compressed data may be streamed out by setting WriteToProgressEvent to true. If streaming is enabled the compressed data will also be provided via the Progress event. If ArchiveFile 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 and FileDecompressedName. These should be specified before invoking Compress, either manually or by invoking IncludeFiles.

The BeginFile and EndFile events will be fired as files are processed, and the Progress event will be fired as data is compressed.

Existing files will be overwritten by the class if OverwriteFiles is set to true. Finer control over which files are overwritten may be gained by trapping the Overwrite event.

Example (Creating an Archive)

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

Error Handling (C++)

Config Method (Zip Class)

Sets or retrieves a configuration setting.

Syntax

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworkszip_zip_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

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

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

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

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Delete Method (Zip Class)

Deletes one or more files from an existing archive.

Syntax

ANSI (Cross Platform)
int Delete(const char* lpszFilenames);

Unicode (Windows)
INT Delete(LPCWSTR lpszFilenames);

int ipworkszip_zip_delete(void* lpObj, const char* lpszFilenames);

int Delete(const QString& qsFilenames);

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:

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

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 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, and any files marked as excluded will not be deleted. When Delete is used to delete a single file, the value of ExcludedFiles will be ignored.

When the method is invoked, the Scan method will first be invoked, if it has not been invoked already. Note that if IncludeFiles has been invoked, or if the values of FileCompressedName and FileDecompressedName for each file in the Files collection have been set, this information will be reset by the call to Scan.

When deleting multiple files, the class 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; it will not delete the files from the disk.

Example

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

Error Handling (C++)

Extract Method (Zip Class)

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

Syntax

ANSI (Cross Platform)
int Extract(const char* lpszFilenames);

Unicode (Windows)
INT Extract(LPCWSTR lpszFilenames);

int ipworkszip_zip_extract(void* lpObj, const char* lpszFilenames);

int Extract(const QString& qsFilenames);

Remarks

Extract extracts one or more files from the archive. The file(s) will be extracted to the directory specified by ExtractToPath, and given the names found in the archive or specified by the FileDecompressedName of the file in the Files collection.

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 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, and any files marked as excluded will not be extracted. When Extract is used to extract a single file, the value of ExcludedFiles will be ignored.

To extract all files in the archive, the ExtractAll method may be used.

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

Example

ZipControl.ArchiveFile = "c:\test.tar" ZipControl.ExcludedFiles = "*.bak | backup/" ZipControl.ExtractToPath = "c:\temp" ZipControl.Extract("*") Example ZipControl.ArchiveFile = "c:\test.zip" ZipControl.ExcludedFiles = "" ZipControl.ExtractToPath = "c:\temp" ZipControl.Extract("code/") Example ZipControl.ArchiveFile = "c:\test.jar" ZipControl.ExcludedFiles = "*.txt" ZipControl.ExtractToPath = "c:\" ZipControl.Extract("* | docs/readme.txt")

Error Handling (C++)

ExtractAll Method (Zip Class)

Extracts all files from the compressed archive.

Syntax

ANSI (Cross Platform)
int ExtractAll();

Unicode (Windows)
INT ExtractAll();

int ipworkszip_zip_extractall(void* lpObj);

int ExtractAll();

Remarks

ExtractAll extracts all files from the archive. The file(s) will be extracted to the directory specified by ExtractToPath, and given the names found in the archive or specified by the FileDecompressedName field of the file in the Files collection.

If Scan has not been invoked when ExtractAll is called, Scan 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 should be invoked before setting the FileDecompressedName field.

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

Example (Extracting from an Archive)

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

Error Handling (C++)

IncludeFiles Method (Zip Class)

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

Syntax

ANSI (Cross Platform)
int IncludeFiles(const char* lpszfilenames);

Unicode (Windows)
INT IncludeFiles(LPCWSTR lpszfilenames);

int ipworkszip_zip_includefiles(void* lpObj, const char* lpszfilenames);

int IncludeFiles(const QString& qsfilenames);

Remarks

IncludeFiles may be used before Compress, 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 field, and without a pathname in the FileCompressedName 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 is set to true. When recursing into subdirectories, relative path information will be stored in FileCompressedName field of the Files collection.

The ExcludedFiles may be used to limit the files to be compressed. This property is checked when Compress 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 class, or remove old values of FileCompressedName and FileDecompressedName. This may be done by first clearing the Files collection.

Example

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

Error Handling (C++)

Reset Method (Zip Class)

Resets the class.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworkszip_zip_reset(void* lpObj);

int Reset();

Remarks

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

Error Handling (C++)

Scan Method (Zip Class)

Scans the compressed archive.

Syntax

ANSI (Cross Platform)
int Scan();

Unicode (Windows)
INT Scan();

int ipworkszip_zip_scan(void* lpObj);

int Scan();

Remarks

This method will scan the archive specified by ArchiveFile. 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 may be changed if desired, and any number of files may be decompressed. The Extract method allows you to decompress files of your choice, and the ExtractAll method will decompress the entire archive.

Changing the values of the FileCompressedName field or the number of files in the Files collection will invalidate the scan. If either of these is changed and Extract or ExtractAll 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

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

Error Handling (C++)

SetArchiveInputStream Method (Zip Class)

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

Syntax

ANSI (Cross Platform)
int SetArchiveInputStream(IPWorksZipStream* sArchiveStream);

Unicode (Windows)
INT SetArchiveInputStream(IPWorksZipStream* sArchiveStream);

int ipworkszip_zip_setarchiveinputstream(void* lpObj, IPWorksZipStream* sArchiveStream);

int SetArchiveInputStream(IPWorksZipStream* sArchiveStream);

Remarks

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

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

Error Handling (C++)

SetArchiveOutputStream Method (Zip Class)

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

Syntax

ANSI (Cross Platform)
int SetArchiveOutputStream(IPWorksZipStream* sArchiveStream);

Unicode (Windows)
INT SetArchiveOutputStream(IPWorksZipStream* sArchiveStream);

int ipworkszip_zip_setarchiveoutputstream(void* lpObj, IPWorksZipStream* sArchiveStream);

int SetArchiveOutputStream(IPWorksZipStream* sArchiveStream);

Remarks

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

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

Error Handling (C++)

Update Method (Zip Class)

Will update certain files in an archive.

Syntax

ANSI (Cross Platform)
int Update(const char* lpszFilenames);

Unicode (Windows)
INT Update(LPCWSTR lpszFilenames);

int ipworkszip_zip_update(void* lpObj, const char* lpszFilenames);

int Update(const QString& qsFilenames);

Remarks

When this method is called, the class 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 class which files in the collection/archive must be updated.

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.

Error Handling (C++)

BeginFile Event (Zip Class)

Fired before each file is processed.

Syntax

ANSI (Cross Platform)
virtual int FireBeginFile(ZipBeginFileEventParams *e);

typedef struct {
  int Index;
  int Skip;
  int reserved;
} ZipBeginFileEventParams;


Unicode (Windows)
virtual INT FireBeginFile(ZipBeginFileEventParams *e);

typedef struct {
  INT Index;
  BOOL Skip;
  INT reserved;
} ZipBeginFileEventParams;

#define EID_ZIP_BEGINFILE 1

virtual INT IPWORKSZIP_CALL FireBeginFile(INT &iIndex, BOOL &bSkip);

class ZipBeginFileEventParams {
public:
  int Index();

  bool Skip();
  void SetSkip(bool bSkip);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void BeginFile(ZipBeginFileEventParams *e);

// Or, subclass Zip and override this emitter function.
virtual int FireBeginFile(ZipBeginFileEventParams *e) {...}

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, FileDecompressedName, FileCompressedSize (decompression only), and FileDecompressedSize 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 and/or ExtractToPath. If FileDecompressedName is set to an empty string, the file will not be written to disk. If WriteToProgressEvent is true, the file will still be decompressed, and the data may be extracted through the Progress event.

This event may also be trapped while compressing. FileCompressedName and FileDecompressedName 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 Class)

Fired after each file is processed.

Syntax

ANSI (Cross Platform)
virtual int FireEndFile(ZipEndFileEventParams *e);

typedef struct {
  int Index;
  int reserved;
} ZipEndFileEventParams;


Unicode (Windows)
virtual INT FireEndFile(ZipEndFileEventParams *e);

typedef struct {
  INT Index;
  INT reserved;
} ZipEndFileEventParams;

#define EID_ZIP_ENDFILE 2

virtual INT IPWORKSZIP_CALL FireEndFile(INT &iIndex);

class ZipEndFileEventParams {
public:
  int Index();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndFile(ZipEndFileEventParams *e);

// Or, subclass Zip and override this emitter function.
virtual int FireEndFile(ZipEndFileEventParams *e) {...}

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, FileDecompressedName, FileCompressedSize, and FileDecompressedSize fields in the Files collection for this index contain more detailed information about the file processed.

Error Event (Zip Class)

Information about non-fatal errors.

Syntax

ANSI (Cross Platform)
virtual int FireError(ZipErrorEventParams *e);

typedef struct {
  const char *Description;
  int ErrorCode;
  int Index;
  const char *Filename;
  int Ignore;
  int reserved;
} ZipErrorEventParams;


Unicode (Windows)
virtual INT FireError(ZipErrorEventParams *e);

typedef struct {
  LPCWSTR Description;
  INT ErrorCode;
  INT Index;
  LPCWSTR Filename;
  BOOL Ignore;
  INT reserved;
} ZipErrorEventParams;

#define EID_ZIP_ERROR 3

virtual INT IPWORKSZIP_CALL FireError(LPSTR &lpszDescription, INT &iErrorCode, INT &iIndex, LPSTR &lpszFilename, BOOL &bIgnore);

class ZipErrorEventParams {
public:
  const QString &Description();

  int ErrorCode();

  int Index();

  const QString &Filename();

  bool Ignore();
  void SetIgnore(bool bIgnore);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(ZipErrorEventParams *e);

// Or, subclass Zip and override this emitter function.
virtual int FireError(ZipErrorEventParams *e) {...}

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 class 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 Class)

Fired whenever a file exists and may be overwritten.

Syntax

ANSI (Cross Platform)
virtual int FireOverwrite(ZipOverwriteEventParams *e);

typedef struct {
  char *Filename;
  int Overwrite;
  int reserved;
} ZipOverwriteEventParams;


Unicode (Windows)
virtual INT FireOverwrite(ZipOverwriteEventParams *e);

typedef struct {
  LPWSTR Filename;
  BOOL Overwrite;
  INT reserved;
} ZipOverwriteEventParams;

#define EID_ZIP_OVERWRITE 4

virtual INT IPWORKSZIP_CALL FireOverwrite(LPSTR &lpszFilename, BOOL &bOverwrite);

class ZipOverwriteEventParams {
public:
  const QString &Filename();
  void SetFilename(const QString &qsFilename);

  bool Overwrite();
  void SetOverwrite(bool bOverwrite);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Overwrite(ZipOverwriteEventParams *e);

// Or, subclass Zip and override this emitter function.
virtual int FireOverwrite(ZipOverwriteEventParams *e) {...}

Remarks

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

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

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

Either of the parameters may be changed when the event is fired. Changing the value of Overwrite will override the default behavior of the class, 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 Class)

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

Syntax

ANSI (Cross Platform)
virtual int FirePassword(ZipPasswordEventParams *e);

typedef struct {
  int Index;
  char *Password;
  int reserved;
} ZipPasswordEventParams;


Unicode (Windows)
virtual INT FirePassword(ZipPasswordEventParams *e);

typedef struct {
  INT Index;
  LPWSTR Password;
  INT reserved;
} ZipPasswordEventParams;

#define EID_ZIP_PASSWORD 5

virtual INT IPWORKSZIP_CALL FirePassword(INT &iIndex, LPSTR &lpszPassword);

class ZipPasswordEventParams {
public:
  int Index();

  const QString &Password();
  void SetPassword(const QString &qsPassword);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Password(ZipPasswordEventParams *e);

// Or, subclass Zip and override this emitter function.
virtual int FirePassword(ZipPasswordEventParams *e) {...}

Remarks

This event is fired when the class 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 class 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 Class)

Fired as progress is made.

Syntax

ANSI (Cross Platform)
virtual int FireProgress(ZipProgressEventParams *e);

typedef struct {
  const char *Data;
  int lenData;
  const char *Filename;
  int64 BytesProcessed;
  int PercentProcessed;
  int reserved;
} ZipProgressEventParams;


Unicode (Windows)
virtual INT FireProgress(ZipProgressEventParams *e);

typedef struct {
  LPCSTR Data;
  INT lenData;
  LPCWSTR Filename;
  LONG64 BytesProcessed;
  INT PercentProcessed;
  INT reserved;
} ZipProgressEventParams;

#define EID_ZIP_PROGRESS 6

virtual INT IPWORKSZIP_CALL FireProgress(LPSTR &lpData, INT &lenData, LPSTR &lpszFilename, LONG64 &lBytesProcessed, INT &iPercentProcessed);

class ZipProgressEventParams {
public:
  const QByteArray &Data();

  const QString &Filename();

  qint64 BytesProcessed();

  int PercentProcessed();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Progress(ZipProgressEventParams *e);

// Or, subclass Zip and override this emitter function.
virtual int FireProgress(ZipProgressEventParams *e) {...}

Remarks

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

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

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

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

If WriteToProgressEvent is false, Data will contain null.

IPWorksZipStream Type

Syntax

IPWorksZipStream (declared in ipworkszip.h)

Remarks

The Zip class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the IPWorksZipStream interface and pass the Zip class an instance of that concrete class.

When implementing the IPWorksZipStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

Properties

CanRead	Whether the stream supports reading. bool CanRead() { return true; }
CanSeek	Whether the stream supports seeking. bool CanSeek() { return true; }
CanWrite	Whether the stream supports writing. bool CanWrite() { return true; }
Length	Gets the length of the stream, in bytes. int64 GetLength() = 0;
Methods

Close	Closes the stream, releasing all resources currently allocated for it. void Close() {} This method is called automatically when an IPWorksZipStream object is deleted.
Flush	Forces all data held by the stream's buffers to be written out to storage. int Flush() { return 0; } Must return `0` if flushing is successful; or `-1` if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return `0`.
Read	Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read. int Read(void* buffer, int count) = 0; `Buffer` specifies the buffer to populate with data from the stream. `Count` specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into `Buffer`; this may be less than `Count` if that many bytes are not currently available, or `0` if the end of the stream has been reached. Must return `-1` if an error occurs, if reading is not supported, or if the stream is closed.
Seek	Sets the current position within the stream based on a particular point of origin. int64 Seek(int64 offset, int seekOrigin) = 0; `Offset` specifies the offset in the stream to seek to, relative to `SeekOrigin`. Valid values for `SeekOrigin` are: `0`: Seek from beginning. `1`: Seek from current position. `2`: Seek from end. Must return the new position within the stream; or `-1` if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If `-1` is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an `Offset` of `0` and a `SeekOrigin` of `1` to obtain the current position within the stream, even if seeking is not otherwise supported.
Write	Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written. int Write(const void* buffer, int count) = 0; `Buffer` specifies the buffer with data to write to the stream. `Count` specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than `Count` if that many bytes could not be written. Must return `-1` if an error occurs, if writing is not supported, or if the stream is closed.

Config Settings (Zip Class)

The class 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 class, access to these internal properties is provided through the Config 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 specified. For added security, a random salt value is generated, and a unique key will be generated for every unique combination of Password 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 class 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 class 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 class will allow encrypted files to be streamed out during compression; i.e., the class will allow you to compress with WriteToProgressEvent set to true and a Password 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 are extracted directly to the specified ExtractToPath. Folders contained within the ArchiveFile will not be created within the ExtractToPath. If an archive contains files with the same name, you can control whether or not they get overwritten by setting OverwriteFiles.

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 is called the hash will be computed for each file within the archive and FileHash will be populated with the computed hash value. Possible values are:

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

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 class 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 event and set this property value as appropriate for each file.

OverwriteReadonlyFiles: Whether to overwrite readonly files.

If true, the class will overwrite readonly files when decompressing. If false (the default), the class will fire the Error 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 class 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.

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 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: 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 is set to true, then all data produced through invocations of Extract, ExtractAll, and Compress will be written to the Progress 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 is set to false, the data will not be streamed out, and the Data parameter of the Progress event will contain null.

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

By default, Password encryption is not allowed for archives created with WriteToProgressEvent set to true. You may set the 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 class 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.

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

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

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

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

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

Trappable Errors (Zip Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Errors

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

Note that some non-fatal errors may be trapped and explicitly ignored in the Error event. This will allow the class 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).