Monkeybread Software - MBS FileMaker Plugin: Archive.FileList

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

Archive.FileList

Lists file paths in the archive.

Component	Version	macOS	Windows	Linux	Server	iOS SDK
Archive	9.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	✅ Yes

MBS( "Archive.FileList"; Archive { ; Passphrase; Options } ) More

Parameters

Parameter Description Example Flags

Archive Either container with archive or native file path. "C:\test\test.zip"

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.

Parameter	Description	Example	Flags
Archive	Either container with archive or native file path.	"C:\test\test.zip"
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 list or error.

Description

Lists file paths in the archive.
Please use Archive.Content if you need more details.
This provides file list, which you can filter and then pass to Archive.Extract.

Examples

Get file list:

Set Variable [ $list ; Value: MBS("Archive.FileList"; If(IsEmpty($Path); $Container; $Path)) ]
If [ MBS("IsError") ]
Show Custom Dialog [ "Failed to read container" ; $list ]
Else
Set Variable [ $Content ; Value: MBS("JSON.Colorize"; $list) ]
End If

<?xml version="1.0" encoding="UTF-8"?>
<fmxmlsnippet type="FMObjectList">
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS("Archive.FileList"; If(IsEmpty($Path); $Container; $Path)) </Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$list</Name>
  </Step>
  <Step enable="True" id="68" name="If">
    <Restore state="False"/>
    <Calculation> MBS("IsError") </Calculation>
  </Step>
  <Step enable="True" id="87" name="Show Custom Dialog">
    <Title>
      <Calculation> "Failed to read container" </Calculation>
    </Title>
    <Message>
      <Calculation>$list </Calculation>
    </Message>
    <Buttons>
      <Button CommitState="True">
        <Calculation>"OK"</Calculation>
      </Button>
      <Button CommitState="False">
        <Calculation>"Cancel"</Calculation>
      </Button>
      <Button CommitState="False"/>
    </Buttons>
  </Step>
  <Step enable="True" id="69" name="Else">
    <Restore state="False"/>
  </Step>
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS("JSON.Colorize"; $list) </Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$Content</Name>
  </Step>
  <Step enable="True" id="70" name="End If"/>
</fmxmlsnippet>

List files with using Windows ANSI encoding:

MBS( "Archive.FileList"; "/Users/cs/Desktop/test.zip"; ""; "hdrcharset=cp1252")

List files with using Japanese CodePage text encoding for older zip archive:

MBS( "Archive.FileList"; "/Users/cs/Desktop/test.zip"; ""; "hdrcharset=cp932")

Release notes

Version 14.3
- Added Options parameter for Archive.Content, Archive.Extract, Archive.ExtractFile, Archive.FileList and Archive.GZipDecompress functions.
Version 11.5
- Fixed an issue with Archive.FileList function not picking up file names on Windows due to text encoding issue.
Version 10.0
- Fixed problem in Archive.FileList and Archive.Content not returning error if encrypted archive could not be read.

Blog Entries

FileMaker Magazin

Ausgabe 4/2023, Seite 38

This function checks for a license.

Created 8th December 2018, last changed 5th September 2025

Archive.ExtractFile - Archive.GZipDecompress

💬 Ask a question or report a problem