IPWorks ZIP 2020 ActiveX Edition

Questions / Feedback?

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

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks ZIP 2020 ActiveX Edition - Version 20.0 [Build 7720]