Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

Archive.Extract

Extracts files in an archive.

Component Version macOS Windows Linux Server iOS SDK
Archive 9.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "Archive.Extract"; Archive; FileList; DestinationFolder { ; Passphrase; Options } )   More

Parameters

Parameter Description Example Flags
Archive Either container with archive or native file path. "C:\test\test.zip"
FileList Optional list of files to extract.
Pass empty text when you need all files.		 ""
DestinationFolder The native path to the destination folder. "/Users/cs/Desktop"
Passphrase Password to use. Optional
Options The options to pass to reader.
This is a comma-separated list of options. Option names can be prefixed with module name.		 Optional

Added in version 14.3.

Result

Returns OK or error.

Description

Extracts files in an archive.
Restores file permissions, times, Mac metadata and file flags.

Use Archive.ExtractFile if you only need one file as container.
You may need to use Plugin.LoadIconvLibrary to load iconv library for text conversion.

Examples

Expand an archive:

MBS( "Archive.Extract";
"/Users/cs/Desktop/invoices-2019-02-12_1924.zip"; /* path to archive (or container) */
"" /* all files */;
"/Users/cs/Desktop/"; /* dest */
"98234kjh245234" /* password */)

See also

Release notes

Blog Entries

This function checks for a license.

Created 11st December 2018, last changed 4th July 2024


Archive.Create - Archive.ExtractFile