Tar Component [IP*Works! ZIP V8]
Properties
Methods
Events
Configuration Settings
The Tar component implements a tar archive utility, compatible with the
UNIX tar and untar utilities. The component supports the old v7 tar format.
The component also implements gzip compression and can be used to create
or decompress .tar.gz archives.
NOTE: What follows is a very short description of the component interfaces.
For more information, please consult the help files that come with the respective package.
Remarks
The interface is identical to that of the Zip component, 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 Files and Files.
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 Files 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 component.
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:\unzipped\"
ZipControl.ExtractAll()
Property List
The following is the full list of the properties of the component with short
descriptions. Click on the links for further details.
| |
| ArchiveFile | The name of the zip, gzip, tar, or jar archive. |
| ExcludedFiles | A list of files to exclude. |
| ExtractToPath | A base path to decompress to. |
| FileCount | The number of records in the File arrays. |
| FileCompressedDate | The date and time of the entry, as stored within the archive. |
| FileCompressedName | The file name of the current file, as stored inside of the archive. |
| FileCompressedSize | The size of the compressed data, as compressed within the archive. |
| FileDecompressedName | The name of the file in the archive, as stored on the file system, outside the archive. |
| FileDecompressedSize | The size of the file, as decompressed outside the archive. |
| FileHardLinkName | The hard link name, for a file that represents a hard link. |
| FilePermissions | This property contains the UNIX permissions of the file, as stored in the tar archive. |
| FileSymLinkName | The symbolic link name, for a file that represents a symbolic link. |
| OverwriteFiles | Whether or not to overwrite files. |
| RecurseSubdirectories | Whether or not to recurse into subdirectories. |
| UseGzipCompression | Whether or not to use gzip compression. |
Method List
The following is the full list of the methods of the component with short
descriptions. Click on the links for further details.
| |
| Abort | Aborts the current operation. |
| Append | Adds a file to an existing archive. |
| Compress | Creates the compressed archive. |
| Config | Sets or retrieves a configuration setting. |
| Delete | Deletes one or more files from an existing archive. |
| Extract | Extracts a single file, directory, or group of files, from the archive. |
| ExtractAll | Extracts all files from the compressed archive. |
| IncludeFiles | Specifies that the indicated files should be added to the archive. |
| Reset | Resets the component. |
| Scan | Scans the compressed archive. |
Event List
The following is the full list of the events fired by the component with short
descriptions. Click on the links for further details.
| |
| BeginFile | Fired before each file is processed. |
| EndFile | Fired after each file is processed. |
| Error | Information about non-fatal errors. |
| Overwrite | Fired whenever a file exists and may be overwritten. |
| Progress | Fired as progress is made. |
Configuration Settings
The following is a list of configuration settings for the component with short
descriptions. Click on the links for further details.
