Tar Configuration
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.Tar Configuration Settings
| ExtraNullBytes: Extra null bytes to append to the end of the file. If ExtraNullBytes is set to a nonzero value, the class 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. | |
| 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 class 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 class will write all output files with default permissions. | |
| 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
| 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. | |
| OverwriteReadonlyFiles: Whether to overwrite readonly files. If true, the class will overwrite readonly files when decompressing. If false (the default), the class will fire the Error event, instead, and will fail with an exception if the error is not trapped and explicitly ignored in the event. |
Base Configuration Settings
| SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20. |
Base Configuration Settings
| CodePage: The system code page used for Unicode to Multibyte translations. The default code page is the Active Code Page (0). The following is a list of valid code page identifiers:
The following is a list of valid code page identifiers for Mac OS only:
|