This command will unzip a Zip archive file to the destination you provide.
Parameter: filename
Type: string
Description: Path and name of the source Zip archive file to be unzipped.
Parameter: destination
(optional)
Type: string
Description: Path to the destination starting directory for the files in
the zip archive. If
this parameter is not provided, the files in the Zip archive will be unzipped
to the same directory as the source zip file.
Parameter: IgnoreZipDirs
(optional)
Type: boolean
Description: If True, the zip directories within the Zip archive will be
ignored and all of the files will be unzipped into the destination directory
only. (Note:
Two files of the same name in different Zip archive directories will result
in only one of them existing at the end of the UnZip operation if this
parameter is set to True.) (Default is False)
Parameter: OverWrite
(optional)
Type: boolean
Description: If set to True, existing destination files will be overwritten.
(Default is False)
Parameter: password
(optional)
Type: string
Description: If the source Zip archive was created with a password, provide
it in this parameter.
Parameter: Status
Type: Object
Description: The status object is used to determine when the zip procedure
is complete. The
zip procedure is launched in a new thread (process) so that other events
may run during lengthy zip/unzip procedures. Use
the .Finished property of this object to determine when the operation
is complete. The
Status object has these usable properties:
Finished - Returns True/False status letting your script or application know when the operation is finished.
ZipError - Returns a string. An empty string value indicates no problem. A value in ZipError usually indicates an error condition, but it may also be used for informational warnings about the zip/unzip procedure performed.
ThreadID - Returns an integer value of the thread ID of the zip/unzip operation. This is used for diagnostic purposes. A value of -1 indicates that the thread ID has not yet been assigned.