Properties Methods Events Config Settings Errors
The ZCompress control implements an LZC compressor and decompressor. It is compatible with the UNIX compress utility.
The LZC file format is used only to archive a single file. Accordingly, the operation of the control is simpler than that of the other controls.
To compress with the control, set ArchiveFile to the name of the LZC compressed file to be created, and FileDecompressedName to the name of the file to be compressed. Finally, invoke Compress. To extract the file, first set ArchiveFile. FileDecompressedName may then be set; if not, it will automatically be set based on the ArchiveFile name. Finally, invoke the Extract method.
Example (Creating an LZC File)
ZipControl.ArchiveFile = "c:\test.Z"
ZipControl.FileDecompressedName = "c:\test.txt"
Example (Extracting from an LZC File)
ZipControl.ArchiveFile = "c:\test.Z"
ZipControl.FileDecompressedName = "c:\test.txt"
The following is the full list of the properties of the control with short descriptions. Click on the links for further details.
|ArchiveFile||The name of the zip, gzip, tar, or jar archive.|
|FileDecompressedName||File name to decompress to, or compress from.|
|FileInputData||The data of the file to be compressed.|
|ZCompressData||(Decompression only) The LZC compressed file contents as a byte array.|
The following is the full list of the methods of the control with short descriptions. Click on the links for further details.
|Abort||Aborts the current operation.|
|Compress||Creates the compressed archive.|
|Config||Sets or retrieves a configuration setting.|
|Extract||Extracts the compressed file from the archive.|
|Reset||Resets the control.|
The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.
|BeginFile||Fired before a file is processed.|
|EndFile||Fired after a 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.|
The following is a list of config settings for the control with short descriptions. Click on the links for further details.
|WriteToProgressEvent||Whether or not to write data to the Progress Event.|
|CodePage||The system code page used for Unicode to Multibyte translations.|
|MaskSensitive||Whether sensitive data is masked in log messages.|
|UseInternalSecurityAPI||Tells the control whether or not to use the system security libraries or an internal implementation.|
ArchiveFile Property (ZCompress Control)
The name of the zip, gzip, tar, or jar archive.
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
Note: an archive already open for read may be closed by setting ArchiveFile to the empty string ("").
FileDecompressedName Property (ZCompress Control)
File name to decompress to, or compress from.
FileDecompressedName contains the name of the file in the archive, as stored on the file system, outside the archive.
When compressing a file and SetFileInputStream has not been called with a valid input stream, 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 when Compress is called, a trappable error will be generated, and the archive will not be correctly written.
When decompressing files, this property may be set prior to calling Extract. If this property is set to the empty string when Extract is called, Extract will automatically set this property to an appropriate value.
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.
FileInputData Property (ZCompress Control)
The data of the file to be compressed.
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.
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.
ZCompressData Property (ZCompress Control)
(Decompression only) The LZC compressed file contents as a byte array.
Normally you should set ArchiveFile before invoking Extract. If you prefer to read the LZC compressed file from memory you may set ZCompressData instead. ZCompressData should be set to the entire contents of the LZC compressed 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 you should set the value of FileDecompressedName to an empty string. Then, when you invoke Extract the data will be provided in the Progress event.
This property is write-only. Note that modifying a LZC compressed file stored in ZCompressData is not supported.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .ZCompressDataB.
This property is write-only and not available at design time.
Abort Method (ZCompress Control)
Aborts the current operation.
Abort may be used to immediately interrupt compression or decompression. Any files partially written by the control will be deleted.
Compress Method (ZCompress Control)
Creates the compressed archive.
Invoking Compress creates the archive specified by ArchiveFile. When the method is called, the file specified by FileDecompressedName will be opened, and the file specified by ArchiveFile will contain the compressed output.
Config Method (ZCompress Control)
Sets or retrieves a configuration setting.
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.
Extract Method (ZCompress Control)
Extracts the compressed file from the archive.
Invoking Extract decompresses the archive specified by ArchiveFile. The compressed file will be extracted, and written to disk.
If FileDecompressedName is set to a nonempty string the file will be written there. Otherwise the control will automatically set FileDecompressedName to an appropriate value:
If FileDecompressedName is empty and ArchiveFile ends in ".Z", this filename, less the ".Z" extension will be used. Otherwise the extension ".uncompressed" will be appended to the file name.
Reset Method (ZCompress Control)
Resets the control.
Reset resets the state of the control. All properties will be set to their default values, and any files open will be closed.
BeginFile Event (ZCompress Control)
Fired before a file is processed.
Sub zcompresscontrol_BeginFile(Index As Integer, Skip As Boolean)
BeginFile is fired before compression or decompression begins. Index will contain 0.
You may use the Skip parameter to tell the component to skip the file when compressing or decompressing.
EndFile Event (ZCompress Control)
Fired after a file is processed.
Sub zcompresscontrol_EndFile(Index As Integer)
EndFile is fired when compression or decompression finishes. Index will contain 0.
Error Event (ZCompress Control)
Information about non-fatal errors.
Sub zcompresscontrol_Error(Description As String, ErrorCode As Integer, Index As Integer, Filename As String, Ignore As Boolean)
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:
|1||Bad or missing CRC-32 checksum.|
|2||Failed to set creation date of a file.|
|111||Can'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 (ZCompress Control)
Fired whenever a file exists and may be overwritten.
Sub zcompresscontrol_Overwrite(Filename As String, Overwrite As Boolean)
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 (ZCompress Control)
Fired as progress is made.
Sub zcompresscontrol_Progress(Data As String, Filename As String, BytesProcessed As Long64, PercentProcessed As Integer)
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.
Config Settings (ZCompress 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.
ZCompress Config Settings
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 Config Settings
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:
Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to to mask sensitive data. The default is .
This setting only works on these controls: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Tells the control whether or not to use the system security libraries or an internal implementation.
When set to , the control will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this setting to tells the control to use the internal implementation instead of using the system security libraries.
This setting is set to by default on all platforms.
Trappable Errors (ZCompress 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.
|20112 Can't open file for read.|
|20113 Can't open file for write.|
|20114 Can't create directory.|
|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.|
|20125 Must specify the compressed name.|
|20128 Bad CRC-32 checksum.|
|20129 Unable to set file date.|
|20134 File already exists in the archive.|
|20151 An I/O error has occurred (details follow).|