Zip Module

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

IPWorksZip.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 FilesDecompressedName and FilesCompressedName. 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 FilesDecompressedName 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 module with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

ArchiveFile Property (Zip Module)

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

Syntax

• Swift
• Objective-C

public var archiveFile: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=archiveFile,setter=setArchiveFile:) NSString* archiveFile;

- (NSString*)archiveFile;
- (void)setArchiveFile :(NSString*)newArchiveFile;

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 ("").

CompressionLevel Property (Zip Module)

The compression level to use.

Syntax

• Swift
• Objective-C

public var compressionLevel: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=compressionLevel,setter=setCompressionLevel:) int compressionLevel;

- (int)compressionLevel;
- (void)setCompressionLevel :(int)newCompressionLevel;

Default Value

4

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.

CompressionMethod Property (Zip Module)

The compression method to use.

Syntax

• Swift
• Objective-C

public var compressionMethod: ZipCompressionMethods {
  get {...}
  set {...}
}

public enum ZipCompressionMethods: Int32 {
  case cmDeflate = 0
  case cmPPMd = 1
  case cmBzip2 = 2
}

@property (nonatomic,readwrite,assign,getter=compressionMethod,setter=setCompressionMethod:) int compressionMethod;

- (int)compressionMethod;
- (void)setCompressionMethod :(int)newCompressionMethod;

Default Value

0

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)

EncryptionAlgorithm Property (Zip Module)

The algorithm used to encrypt files written to the archive.

Syntax

• Swift
• Objective-C

public var encryptionAlgorithm: ZipEncryptionAlgorithms {
  get {...}
  set {...}
}

public enum ZipEncryptionAlgorithms: Int32 {
  case eaDefault = 0
  case eaAESWeak = 1
  case eaAESStrong = 2
  case eaAESMaximum = 3
}

@property (nonatomic,readwrite,assign,getter=encryptionAlgorithm,setter=setEncryptionAlgorithm:) int encryptionAlgorithm;

- (int)encryptionAlgorithm;
- (void)setEncryptionAlgorithm :(int)newEncryptionAlgorithm;

Default Value

0

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:

ExcludedFiles Property (Zip Module)

A list of files to exclude.

Syntax

• Swift
• Objective-C

public var excludedFiles: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=excludedFiles,setter=setExcludedFiles:) NSString* excludedFiles;

- (NSString*)excludedFiles;
- (void)setExcludedFiles :(NSString*)newExcludedFiles;

Default Value

""

Remarks

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

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.

ExtractToPath Property (Zip Module)

A base path to decompress to.

Syntax

• Swift
• Objective-C

public var extractToPath: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=extractToPath,setter=setExtractToPath:) NSString* extractToPath;

- (NSString*)extractToPath;
- (void)setExtractToPath :(NSString*)newExtractToPath;

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 FilesDecompressedName 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()

Files Property (Zip Module)

Collection of Zip archive files.

Syntax

• Swift
• Objective-C

public var files: Array<ZIPFile> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=fileCount,setter=setFileCount:) int fileCount;

- (int)fileCount;
- (void)setFileCount :(int)newFileCount;

- (int)fileAttributes:(int)fileIndex;
- (void)setFileAttributes:(int)fileIndex :(int)newFileAttributes;

- (NSString*)fileComment:(int)fileIndex;
- (void)setFileComment:(int)fileIndex :(NSString*)newFileComment;

- (long long)fileCompressedDate:(int)fileIndex;
- (void)setFileCompressedDate:(int)fileIndex :(long long)newFileCompressedDate;

- (NSString*)fileCompressedName:(int)fileIndex;
- (void)setFileCompressedName:(int)fileIndex :(NSString*)newFileCompressedName;

- (long long)fileCompressedSize:(int)fileIndex;

- (int)fileCompressionLevel:(int)fileIndex;
- (void)setFileCompressionLevel:(int)fileIndex :(int)newFileCompressionLevel;

- (long long)fileCRC:(int)fileIndex;

- (NSString*)fileDecompressedName:(int)fileIndex;
- (void)setFileDecompressedName:(int)fileIndex :(NSString*)newFileDecompressedName;

- (long long)fileDecompressedSize:(int)fileIndex;

- (int)fileEncryptionAlgorithm:(int)fileIndex;
- (void)setFileEncryptionAlgorithm:(int)fileIndex :(int)newFileEncryptionAlgorithm;

- (NSString*)fileHash:(int)fileIndex;

- (NSString*)fileInputData:(int)fileIndex;
- (void)setFileInputData:(int)fileIndex :(NSString*)newFileInputData;

- (NSData*)fileInputDataB:(int)fileIndex;
- (void)setFileInputDataB:(int)fileIndex :(NSData*)newFileInputData;
- (NSString*)filePassword:(int)fileIndex;
- (void)setFilePassword:(int)fileIndex :(NSString*)newFilePassword;

- (BOOL)filePasswordRequired:(int)fileIndex;

Default Value

""

Remarks

When a compressed archive is scanned or decompressed, the values of this collection are populated accordingly.

When creating a compressed archive, this property may be used to set the files to be stored. For each entry added to the collection, the FilesDecompressedName field should be set to the name of the file to be decompressed, and the FilesCompressedName field should be set to the filename to store in the archive.

Archives may also be created using the IncludeFiles method. Invoking the IncludeFiles method causes the values of this collection to be filled out. These values may then be changed directly if desired.

OverwriteFiles Property (Zip Module)

Whether or not to overwrite files.

Syntax

• Swift
• Objective-C

public var overwriteFiles: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=overwriteFiles,setter=setOverwriteFiles:) BOOL overwriteFiles;

- (BOOL)overwriteFiles;
- (void)setOverwriteFiles :(BOOL)newOverwriteFiles;

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.

Password Property (Zip Module)

A password for the zip archive.

Syntax

• Swift
• Objective-C

public var password: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=password,setter=setPassword:) NSString* password;

- (NSString*)password;
- (void)setPassword :(NSString*)newPassword;

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

RecurseSubdirectories Property (Zip Module)

Whether or not to recurse into subdirectories.

Syntax

• Swift
• Objective-C

public var recurseSubdirectories: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=recurseSubdirectories,setter=setRecurseSubdirectories:) BOOL recurseSubdirectories;

- (BOOL)recurseSubdirectories;
- (void)setRecurseSubdirectories :(BOOL)newRecurseSubdirectories;

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

ZipComment Property (Zip Module)

The comment for the entire zip file.

Syntax

• Swift
• Objective-C

public var zipComment: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=zipComment,setter=setZipComment:) NSString* zipComment;

- (NSString*)zipComment;
- (void)setZipComment :(NSString*)newZipComment;

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.

ZipData Property (Zip Module)

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

Syntax

• Swift
• Objective-C

public var zipData: String {
  get {...}
  set {...}
}

public var zipDataB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=zipData,setter=setZipData:) NSString* zipData;

- (NSString*)zipData;
- (void)setZipData :(NSString*)newZipData;

@property (nonatomic,readwrite,assign,getter=zipDataB,setter=setZipDataB:) NSData* zipDataB;

- (NSData*)zipDataB;
- (void)setZipDataB :(NSData*)newZipData;

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

Abort Method (Zip Module)

Aborts the current operation.

Syntax

• Swift
• Objective-C

public func abort() throws -> Void

- (void)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.

AppendFiles Method (Zip Module)

Adds specified files to an existing archive.

Syntax

• Swift
• Objective-C

public func appendFiles() throws -> Void

- (void)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.

Compress Method (Zip Module)

Creates the compressed archive.

Syntax

• Swift
• Objective-C

public func compress() throws -> Void

- (void)compress;

Remarks

Invoking Compress creates the archive specified by ArchiveFile. When the method is called, all files specified by the FilesDecompressedName 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 FilesCompressedName and FilesDecompressedName. 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()

Config Method (Zip Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

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.

Delete Method (Zip Module)

Deletes one or more files from an existing archive.

Syntax

• Swift
• Objective-C

public func delete_(fileNames: String) throws -> Void

- (void)delete:(NSString*)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:

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

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 FilesCompressedName and FilesDecompressedName 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")

Extract Method (Zip Module)

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

Syntax

• Swift
• Objective-C

public func extract(fileNames: String) throws -> Void

- (void)extract:(NSString*)fileNames;

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

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

ExtractAll Method (Zip Module)

Extracts all files from the compressed archive.

Syntax

• Swift
• Objective-C

public func extractAll() throws -> Void

- (void)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 FilesDecompressedName 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 FilesDecompressedName 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.

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 (Extracting from an Archive)

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

IncludeFiles Method (Zip Module)

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

Syntax

• Swift
• Objective-C

public func includeFiles(fileNames: String) throws -> Void

- (void)includeFiles:(NSString*)fileNames;

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 FilesDecompressedName field, and without a pathname in the FilesCompressedName 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 FilesCompressedName 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 FilesCompressedName and FilesDecompressedName. This may be done by first clearing the Files collection.

Example

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

Reset Method (Zip Module)

Resets the component.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)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.

Scan Method (Zip Module)

Scans the compressed archive.

Syntax

• Swift
• Objective-C

public func scan() throws -> Void

- (void)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 FilesDecompressedName 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 FilesCompressedName 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

Update Method (Zip Module)

Will update certain files in an archive.

Syntax

• Swift
• Objective-C

public func update(fileNames: String) throws -> Void

- (void)update:(NSString*)fileNames;

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.

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

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

Fired before each file is processed.

Syntax

• Swift
• Objective-C

func onBeginFile(index: Int32, skip: inout Bool)

- (void)onBeginFile:(int)index :(int*)skip;

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 FilesCompressedName, FilesDecompressedName, FilesCompressedSize (decompression only), and FilesDecompressedSize 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 FilesDecompressedName and/or ExtractToPath. If FilesDecompressedName 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. FilesCompressedName and FilesDecompressedName 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 Module)

Fired after each file is processed.

Syntax

• Swift
• Objective-C

func onEndFile(index: Int32)

- (void)onEndFile:(int)index;

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 FilesCompressedName, FilesDecompressedName, FilesCompressedSize, and FilesDecompressedSize fields in the Files collection for this index contain more detailed information about the file processed.

Error Event (Zip Module)

Information about non-fatal errors.

Syntax

• Swift
• Objective-C

func onError(description: String, errorCode: Int32, index: Int32, filename: String, ignore: inout Bool)

- (void)onError:(NSString*)description :(int)errorCode :(int)index :(NSString*)filename :(int*)ignore;

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:

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

Fired whenever a file exists and may be overwritten.

Syntax

• Swift
• Objective-C

func onOverwrite(filename: inout String, overwrite: inout Bool)

- (void)onOverwrite:(NSString**)filename :(int*)overwrite;

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

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

Syntax

• Swift
• Objective-C

func onPassword(index: Int32, password: inout String)

- (void)onPassword:(int)index :(NSString**)password;

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

Fired as progress is made.

Syntax

• Swift
• Objective-C

func onProgress(data: Data, filename: String, bytesProcessed: Int64, percentProcessed: Int32)

- (void)onProgress:(NSData*)data :(NSString*)filename :(long long)bytesProcessed :(int)percentProcessed;

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.

ZIPFile Type

The Zip file in the archive.

Remarks

This type contains information about the Zip file that either exists in the archive or is being added to the archive.

Fields

Constructors

public init()

public init(decompressedName: )

public init(compressedName: , decompressedName: )

public init(compressedName: , inputStream: )

Config Settings (Zip Module)

Zip Config Settings

Base Config Settings

Trappable Errors (Zip Module)

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