Monkeybread Software - MBS FileMaker Plugin: Files.List

Topics All Mac OS X (Only) Windows (Only) Linux (Only, Not) iOS (Only, Not)
Components Crossplatform Mac & Win Server Client Old Guides Examples
New in version: 8.3 8.4 8.5 9.0 9.1 9.2 9.3 9.4 9.5 10.0 Statistic

Files.List

Queries list of file names in folder.

Component	Version	macOS	Windows	Server	FileMaker Cloud	FileMaker iOS SDK
Files	2.8	Yes	Yes	Yes	Yes	Yes

MBS( "Files.List"; Path { ; filter; ExtensionFilter } ) More

Parameters

Parameter Description Example value

Path Native path to the directory. "C:\Test"

filter Optional
Optional, limits what is returned. Default is 0 to report all files. Pass a combination of 1 for showing only files, 2 for showing only directories and 4 for showing only visible items.
Add 8 if the path includes the file name specification with wildcards. 5

ExtensionFilter Optional
Optional, a filter for getting only files with matching file extension. ".txt"

Parameter	Description	Example value
Path	Native path to the directory.	"C:\Test"
filter	Optional Optional, limits what is returned. Default is 0 to report all files. Pass a combination of 1 for showing only files, 2 for showing only directories and 4 for showing only visible items. Add 8 if the path includes the file name specification with wildcards.	5
ExtensionFilter	Optional Optional, a filter for getting only files with matching file extension.	".txt"

Result

Returns list of files separated by return.

Description

Queries list of file names in folder.
The list of names is separated by new line character.
This function needs a native path. Please use Path.FileMakerPathToNativePath function in order to convert a FileMaker style path to a native path.
With filter parameter being 8 on Windows, you can pass a path with wildcards directly and ExtensionFilter parameter is ignored. This is not supported on Mac OS X.

See also Files.ListRecursive. You can filter result with List.MatchesPostfix to get list with one file extension only.

If you need sorting, please check List.Sort function.

Examples

Queries files in Users folder on Mac:

$files = MBS("Files.List"; "/Users")

Queries visible files in windows folder:

$files = MBS("Files.List"; "c:\\Windows\\"; 5)

Queries DLL files in windows folder:

$files = MBS("Files.List"; "c:\\Windows\\"; 0; ".dll")

Queries Applications with name starting with e in windows folder:

$files = MBS("Files.List"; "c:\\Windows\\e*.exe"; 8)

Find FileMaker databases in a folder:

MBS("Files.List"; "c:\\Users\\Christian\\Desktop"; 0; ".fmp12")

Example Databases

Blog Entries

Created 18th August 2014, last changed 4th January 2020

Files.LaunchFile - Files.ListRecursive

Feedback: Report problem or ask question.