This command will zip up files and create a zip archive file.
Parameter: ZipWhat
Type: string
Description: Path to a directory, or path and filename of the directory
or file to be added to a zip archive file.
Parameter: ZipFileName
Type: string
Description: Path and filename of the Zip archive file to be created or
to have files added to.
Parameter: compression
(optional)
Type: integer (.NET Short)
Description: The zip file compression level to use - the higher the level,
the longer the zip operation will take. If
this parameter is not provided, a default value of 6 is used. The
valid values are from 0 to 9.
Parameter: password
(optional)
Type: string
Description: If you wish the file(s) to be password protected in the archive,
provide the password here. (Case sensitive)
Parameter: RemoveBase
(optional)
Type: boolean
Description: If False, the entire directory structure up to and including
the source file or directory will be included in the zip archive. If
this parameter is not provided, then by default it is True and the directory
structure before the starting point of the source files will be removed.
Example: ZipWhat is C:\Program Files\HomeSeer\HTML\MyStuff (a directory) MyStuff has sub-directories Stuff1 and Stuff2.
With this parameter True, the resulting archive will have Stuff1\*.* and Stuff2\*.* in it.
With this parameter False, the resulting archive will have Program Files\HomeSeer\HTML\MyStuff\Stuff1\*.* and Program Files\HomeSeer\HTML\MyStuff\Stuff2\*.* in it.
Parameter: Flatten
(optional)
Type: boolean
Description: If True, the files will be put in the zip archive without
any path information. Files
that have the same filename but are in different subdirectories will result
in only one of the files being left in the archive at the end of the Zip
function.
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.