BuildMaster Documentation

Files - Extract Zip File

  • Last Modified: 2020-06-26

This is generated from the built-in components of BuildMaster 6.2.13, and may be different than what you have installed (especially if you have extensions); go to [User Icon] > Documentation within your BuildMaster instance to see exactly what operations are available.

Extract Zip File

Extracts a zip file on a server.

Script usage:

Extract-ZipFile(
	Name: <text>,
	[Directory: <text>],
	[ClearTarget: <true/false>],
	[Overwrite: <true/false>]
);

This operation may be prefixed with Files::, although this is a built-in namespace and isn't really necessary.

Arguments:

Name Format Script Usage Usage Notes
File name (default)
text
Name
This argument is required.
Target directory
text
Directory
Clear target directory
true/false
ClearTarget
Overwrite
true/false
Overwrite

See also:

Example:

# extracts archive.zip in ArchiveContents after deleting the directory contents
Extract-ZipFile(
    Name: archive.zip,
    Directory: E:\Services\ArchiveContents,
    ClearTarget: true
);

Is this documentation incorrect or incomplete? Help us by contributing!

This documentation is licensed under CC-BY-SA-4.0 and stored in GitHub.

Generated from commit ced119d5 on master