Docs

IPWorks ZIP 2022 ActiveX Edition

Version 22.0 [Build 8214]

Tar Control

Properties   Methods   Events   Configuration Settings   Errors  

The Tar control implements a tar archive utility, compatible with the UNIX tar and untar utilities. The control supports the old v7 tar format. The control also implements gzip compression and can be used to create or decompress .tar.gz archives.

Syntax

Tar

Remarks

The interface is identical to that of the Zip control, and is the same whether gzip compression is used or not. In particular, the Compress method is used to create tar archives, even if actual compression is not used.

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.

tar.gz files may be created or extracted by setting the UseGzipCompression property to true. When Compress is invoked, this will cause all output to be streamed through a gzip compressor as it is written. When extracting or scanning the tar archive will automatically be decompressed and written temporarily to disk. Note that this might cause Scan, Extract, and ExtractAll to operate slowly without firing events.

.gz files may also be compressed or decompressed using the Gzip control.

Example (Creating a Tar File)

ZipControl.ArchiveFile = "c:\test.tar.gz" ZipControl.RecurseSubdirectories = true ZipControl.UseGzipCompression = true ZipControl.IncludeFiles("c:\foo\*") ZipControl.Compress() Example (Extracting from a Tar File)

ZipControl.ArchiveFile = "c:\temp.tar" ZipControl.UseGzipCompression = false ZipControl.ExtractToPath = "c:\extracted\" ZipControl.ExtractAll()

Property List


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

ArchiveFileThe name of the zip, gzip, tar, or jar archive.
ExcludedFilesA list of files to exclude.
ExtractToPathA base path to decompress to.
FileCountThe number of records in the File arrays.
FileCompressedDateThe date and time of the entry, as stored within the archive.
FileCompressedNameThe file name of the current file, as stored inside of the archive.
FileCompressedSizeThe size of the compressed data, as compressed within the archive.
FileDecompressedNameThe name of the file in the archive, as stored on the file system, outside the archive.
FileDecompressedSizeThe size of the file, as decompressed outside the archive.
FileHardLinkNameThe hard link name, for a file that represents a hard link.
FileInputDataWhen This property is set, the control will read in the data from This property instead of reading from the file contained in the DecompressedName property.
FilePermissionsThis property contains the UNIX permissions of the file, as stored in the tar archive.
FileSymLinkNameThe symbolic link name, for a file that represents a symbolic link.
OverwriteFilesWhether or not to overwrite files.
RecurseSubdirectoriesWhether or not to recurse into subdirectories.
TarData(Decompression only) The tar file contents as a byte array.
UseGzipCompressionWhether or not to use gzip compression.

Method List


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

AbortAborts the current operation.
AppendAdds a file to an existing archive.
CompressCreates the compressed archive.
ConfigSets or retrieves a configuration setting.
DeleteDeletes one or more files from an existing archive.
ExtractExtracts a single file, directory, or group of files, from the archive.
ExtractAllExtracts all files from the compressed archive.
IncludeFilesSpecifies that the indicated files should be added to the archive.
ResetResets the control.
ScanScans the compressed archive.

Event List


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

BeginFileFired before each file is processed.
EndFileFired after each file is processed.
ErrorInformation about non-fatal errors.
OverwriteFired whenever a file exists and may be overwritten.
ProgressFired as progress is made.

Configuration Settings


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

CheckForFileLocksIf true, the control requests an exclusive lock during initialization.
CompressionLevelThe level of compression to use when Gzip compression is enabled.
ExcludedAttributesAttributes of files to be excluded.
ExtractFilesOnlyWhether to only extract the files contained within the archive.
ExtraNullBytesExtra null bytes to append to the end of the file.
InvalidCharReplacementReplaces invalid characters with the specified character.
OverwriteReadonlyFilesWhether to overwrite readonly files.
PreserveModifiedTimeWhether or not to preserve the original modified time on extracted files.
SetFilePermissionsWhether to set UNIX file permissions.
SymlinkActionThat action to take when a symlink is encountered.
TempPathThe location where temporary files are created.
WriteToProgressEventWhether or not to write data to the Progress Event.
CodePageThe system code page used for Unicode to Multibyte translations.
UseInternalSecurityAPITells the control whether or not to use the system security libraries or an internal implementation.

ArchiveFile Property (Tar Control)

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

Syntax

tarcontrol.ArchiveFile[=string]

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

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

ExcludedFiles Property (Tar Control)

A list of files to exclude.

Syntax

tarcontrol.ExcludedFiles[=string]

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 control for both compression and extraction. Failure to do so may result in I/O errors or unexpected results.

Data Type

String

ExtractToPath Property (Tar Control)

A base path to decompress to.

Syntax

tarcontrol.ExtractToPath[=string]

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

The number of records in the File arrays.

Syntax

tarcontrol.FileCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

FileCompressedDate Property (Tar Control)

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

Syntax

tarcontrol.FileCompressedDate(FileIndex)[=long64]

Default Value

0

Remarks

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

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

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

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

Reading the value of this property will return a meaningful value only after the archive has been successfully scanned or decompressed, and only if the values of ArchiveFile, Files collection, and FileCompressedName 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 (Tar Control)

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

Syntax

tarcontrol.FileCompressedName(FileIndex)[=string]

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 will not be interpreted correctly by the control, 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 (Tar Control)

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

Syntax

tarcontrol.FileCompressedSize(FileIndex)

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

FileDecompressedName Property (Tar Control)

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

Syntax

tarcontrol.FileDecompressedName(FileIndex)[=string]

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 control. 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 (Tar Control)

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

Syntax

tarcontrol.FileDecompressedSize(FileIndex)

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

FileHardLinkName Property (Tar Control)

The hard link name, for a file that represents a hard link.

Syntax

tarcontrol.FileHardLinkName(FileIndex)[=string]

Default Value

""

Remarks

The hard link name, for a file that represents a hard link. If you specify FileHardLinkName the file will be added to the tar file as a hard link. You should specify the name of the link in FileCompressedName and the name of the linked file in FileHardLinkName.

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

FileInputData Property (Tar Control)

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

Syntax

tarcontrol.FileInputData(FileIndex)[=string]

Default Value

""

Remarks

When This property is set, the control 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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .FileInputDataB.

This property is not available at design time.

Data Type

Binary String

FilePermissions Property (Tar Control)

This property contains the UNIX permissions of the file, as stored in the tar archive.

Syntax

tarcontrol.FilePermissions(FileIndex)[=string]

Default Value

"644"

Remarks

This property contains the UNIX permissions of the file, as stored in the tar archive. It will be written to the tar archive during compression. As native code is not used, permissions are read from and written to the tar archive only, and not to the file system.

The value should be specified as a string of three characters, representing the owner's permissions, the group's permissions, and others' permissions. Each character should be a bitmask of 4 (read access), 2 (write access), or 1 (executable access), as in chmod.

In Java, if the SetFilePermissions configuration setting is set to true, the control will shell out an instance of chmod for each file, and will attempt to set the file permissions to those specified in FilePermissions. Obviously, this functionality is operating system dependent and will fail in Windows in particular; it may also fail in other operating systems for a variety of reasons.

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

FileSymLinkName Property (Tar Control)

The symbolic link name, for a file that represents a symbolic link.

Syntax

tarcontrol.FileSymLinkName(FileIndex)[=string]

Default Value

""

Remarks

The symbolic link name, for a file that represents a symbolic link. If you specify FileSymLinkName the file will be added to the tar file as a symbolic link. You should specify the name of the link in FileCompressedName and the name of the linked file in FileSymLinkName.

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

OverwriteFiles Property (Tar Control)

Whether or not to overwrite files.

Syntax

tarcontrol.OverwriteFiles[=boolean]

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

RecurseSubdirectories Property (Tar Control)

Whether or not to recurse into subdirectories.

Syntax

tarcontrol.RecurseSubdirectories[=boolean]

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

TarData Property (Tar Control)

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

Syntax

tarcontrol.TarData[=string]

Default Value

""

Remarks

Normally you should set ArchiveFile before invoking Scan or Extract. If you prefer to read the tar file from memory you may set TarData instead. TarData should be set to the entire contents of the tar 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 tar file stored in TarData is not supported, so Append, Delete, etc., will throw exceptions.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .TarDataB.

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

Data Type

Binary String

UseGzipCompression Property (Tar Control)

Whether or not to use gzip compression.

Syntax

tarcontrol.UseGzipCompression[=boolean]

Default Value

False

Remarks

If this property is set to true, the control will operate on tar archives that have been compressed with gzip. The interface of the component remains the same. During compression, the data will be streamed through a gzip compressor as it is written to the file. During decompression, the control will unzip the data to a temporary tar archive, and then automatically scan or decompress the tar archive.

The creation of the temporary tar file will occur when the Scan method is invoked (note that this method is invoked automatically by Extract and ExtractAll if it is not invoked explicitly by the user). The entire file must be decompressed, so Scan might operate slowly, and the Progress event will be fired as the tar file is extracted. If Scan is invoked automatically by Extract or ExtractAll, the PercentProcessed parameter of the event will increase from 0 to 100 as the archive is decompressed, and again as files are extracted from the temporary file.

The temporary file will automatically be deleted by the control after it is no longer needed. To extract the tar file itself (rather than its contents), the Gzip control should be used.

Due to the nature of the gzip format, Append and Delete are not supported for .tar.gz files.

If this property is set to false, the control will create and read ordinary, uncompressed tar archives.

NOTE: This is not supported when using an input stream for extraction.

Data Type

Boolean

Abort Method (Tar Control)

Aborts the current operation.

Syntax

tarcontrol.Abort 

Remarks

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

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

Append Method (Tar Control)

Adds a file to an existing archive.

Syntax

tarcontrol.Append DecompressedName, CompressedName

Remarks

Append may be used to add a file to an existing archive. Unlike IncludeFiles, Append compresses and adds the file to the archive as soon as it is invoked.

DecompressedName should be set to the name of the single file to be added. It should be specified with a path if necessary, to allow the control to find it. The value of CompressedName is the name that will be stored in the archive.

When Append 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 have been set for that file in the Files collection, this information will be reset by the call to Scan.

After the file is added, the array properties will be updated appropriately.

This method may only be used to add a file to an existing archive. To add files to a new archive, the IncludeFiles and Compress methods should be used.

Due to the nature of the gzip format, Append and Delete are not supported for .tar.gz files.

Compress Method (Tar Control)

Creates the compressed archive.

Syntax

tarcontrol.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 control 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 (Tar Control)

Sets or retrieves a configuration setting.

Syntax

tarcontrol.Config ConfigurationString

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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 (Tar Control)

Deletes one or more files from an existing archive.

Syntax

tarcontrol.Delete 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 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 control 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 (Tar Control)

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

Syntax

tarcontrol.Extract 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 FileDecompressedName 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 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 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 (Tar Control)

Extracts all files from the compressed archive.

Syntax

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

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

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

Syntax

tarcontrol.IncludeFiles 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 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 control, 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()

Reset Method (Tar Control)

Resets the control.

Syntax

tarcontrol.Reset 

Remarks

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

Scan Method (Tar Control)

Scans the compressed archive.

Syntax

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

BeginFile Event (Tar Control)

Fired before each file is processed.

Syntax

Sub tarcontrol_BeginFile(Index As Integer, Skip As Boolean)

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 the appropriate value of 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 (Tar Control)

Fired after each file is processed.

Syntax

Sub tarcontrol_EndFile(Index As Integer)

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

Information about non-fatal errors.

Syntax

Sub tarcontrol_Error(Description As String, ErrorCode As Integer, Index As Integer, Filename As String, Ignore As Boolean)

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 control will continue operation.

ErrorCode will correspond to one of the following errors:

1Bad or missing CRC-32 checksum.
2Failed to set creation date of a file.
111Can'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 (Tar Control)

Fired whenever a file exists and may be overwritten.

Syntax

Sub tarcontrol_Overwrite(Filename As String, Overwrite As Boolean)

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 control, and cause the file to be overwritten or not overwritten, depending on the value set. If Filename is changed, the value of Overwrite will be ignored, and the file will be written with the specified name. If a file of the new name also exists this file will be silently overwritten.

Progress Event (Tar Control)

Fired as progress is made.

Syntax

Sub tarcontrol_Progress(Data As String, Filename As String, BytesProcessed As Long64, PercentProcessed As Integer)

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.

Configuration Settings (Tar Control)

The control 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 control, access to these internal properties is provided through the Config method.

Tar Configuration Settings

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.

CompressionLevel:   The level of compression to use when Gzip compression is enabled.

This property specifies the level of compression to be used, between 1 and 6. Higher values will cause the control to compress better; lower values will cause the control to compress faster.

The default value is 4.

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.

ExtraNullBytes:   Extra null bytes to append to the end of the file.

If ExtraNullBytes is set to a nonzero value, the control will write the specified number of null bytes whenever it creates a tar file or appends to an existing one. Setting this property to 1024 (or higher) may be necessary to prevent compatibility problems with certain versions of untar.

InvalidCharReplacement:   Replaces invalid characters with the specified character.

This setting replaces all invalid characters encountered during decompression with the specified character.

If this setting is unspecified the invalid characters will not be replaced.

OverwriteReadonlyFiles:   Whether to overwrite readonly files.

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

SetFilePermissions:   Whether to set UNIX file permissions.

In Java, if the SetFilePermissions configuration setting is set to true, the control will shell out an instance of chmod for each file, and will attempt to set the file permissions to those specified in the FilePermissions field of the Files collection. This functionality is operating system dependent and will fail in Windows in particular; it may also fail in other operating systems for a variety of reasons.

By default, the control will write all output files with default permissions.

SymlinkAction:   That action to take when a symlink is encountered.

This setting specifies the action to take when a symlink is encountered during decompression. The control does not support symlinks and will fire the Error event. This setting indicates whether the symlink is ignored, or treated as an error. Possible values are:

0 (Ignore - default) The Error event fires and the Ignore parameter is True.
1 The control fails with an error.

This only applies when decompressing.

TempPath:   The location where temporary files are created.

When an archive uses GZip compression temporary files will be created when calling Scan or Extract. This setting specifies the location of the temporary files. If this setting is unspecified the system temp directory will be used.

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.

By default, this config is set to false.

Base Configuration Settings

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:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

UseInternalSecurityAPI:   Tells the control whether or not to use the system security libraries or an internal implementation.

By default the control will use the system security libraries to perform cryptographic functions where applicable. Setting this to tells the control to use the internal implementation instead of using the system's security API.

Trappable Errors (Tar Control)

Errors

The following errors may be generated by the control. 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 control to continue operation even in case of error.

Tar Errors

20104    The tar archive is of an invalid or unsupported format.
20103    The gzip archive is of an invalid or unsupported format.
20115    The file is too large.
20116    Can't create empty archive.
20117    The archive must be scanned prior to attempting this operation.
20118    The array index is out of range.
20119    The maximum size of the archive has been exceeded.
20120    The archive must be specified, or streaming must be enabled.
20121    The component is busy.
20122    The Append method is not supported for .tar.gz files.
20123    The Delete method is not supported for .tar.gz files.
20125    Must specify the compressed name.
20128    Bad CRC-32 checksum.
20129    Unable to set file date.
20130    Invalid permissions.
20132    Unable to set permissions.
20135    SymLink extraction not supported.
20136    HardLink extraction not supported.
20151    An I/O error has occurred (details follow).

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks ZIP 2022 ActiveX Edition - Version 22.0 [Build 8214]