N-central Help

Compress Folder

This object compress a folder using Windows compression.

Privileges

Normal

Input Parameters

Name Type Required Description
Folder String Yes The full path of the folder to be compressed.
Recurse Boolean No

Select to include all the folders from subdirectories contained in the path for compression.

By default only Folders with files in them are compressed, and subdirectories are excluded from compression.

Output Parameters

Name Type Description
Result Number Returns a success value of zero or any value other than zero to indicate failure.

Example Input Parameters

Name Type Required Example
Folder String Yes C:\folder1\folder2