Jar 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.Jar Configuration Settings
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:
|