Topics   All   MacOS (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Deprecated   Guides   Examples   Videos
New in version: 12.0   12.1   12.2   12.3   12.4   12.5   13.0   13.1   13.2   13.3    Statistic    FMM    Blog  


Compresses one container into a new archive.

Component Version macOS Windows Linux Server iOS SDK
Archive 11.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "Archive.CompressContainer"; Format; Filter; Destination; Container { ; Options; Password } )   More


Parameter Description Example Flags
Format The format to use.
Formats: 7zip, ar, arbsd, argnu, arsvr4, bsdtar, cd9660, cpio, gnutar, iso, iso9660, mtree, mtree-classic, newc, odc, oldtar, pax, paxr, posix, raw, rpax, shar, shardump, ustar, v7tar, v7, warc, xar, zip.
Filter The filter to use.
For zip format can be store or deflate.
Filters: b64encode, bzip2, compress, grzip, gzip, lrzip, lz4, lzip, lzma, lzop, uuencode, xz, zstd.

Not all filters can be combined with all formats.
Destination The native file path to the destinaton archive.
Or file name for container.
Container The container to compress.
We take the file name from container.
Options The options to pass to writer.
This is a comma-separated list of options. Option names can be prefixed with module name.

Sample options:
"zip:encryption=zipcrypt" Optional
Password The passphrase to use for password protection. "secret" Optional


Returns OK, container or error.


Compresses one container into a new archive.
Supports various compression algorithms and encryption.


Compress a container:

Set Field [ MyFile::CompressedFile ; MBS( "Archive.CompressContainer"; "zip"; "deflate"; ""; MyFile::SomeContainer; "hdrcharset=UTF-8" ) ]

Compress a container to a zip file:

Set Variable [ $r ; Value: MBS( "Archive.CompressContainer"; "zip"; "deflate"; "/Users/cs/Desktop/"; Anlagen::SomeContainer; "hdrcharset=UTF-8" ) ]

Compress to gz:

Set Variable [ $r ; Value: MBS( "Archive.CompressContainer"; "zip"; "deflate"; "/Users/cs/Desktop/"; Anlagen::SomeContainer; "gzip:compression-level=9" ) ]

Compress to gzip:

Set Variable [ $r ; Value: MBS( "Archive.CompressContainer"; "raw"; "gzip"; "/Users/cs/Desktop/test2.jpg.gz"; Contacts::Photo Container) ]

See also

Release notes

Blog Entries

This function checks for a paid license.

Created 22nd February 2021, last changed 19th November 2021

Archive.Compress - Archive.Content

💬 Ask a question or report a problem

Start Chat