Get(DocumentsPathListing)
Purpose
Returns a list of all files and folders in the Documents folder returned by the Get(DocumentsPath) function.
Format
Get(DocumentsPathListing)
Parameters
None
Data type returned
text
Originated in
FileMaker Pro 10.0
Description
Each pathname in the Documents folder is listed separated by a line break. Files and folders are named according to FileMaker Pro naming conventions.
Use Get(DocumentsPathListing) with the
Import Records script step and
Export Records script step to determine if a file exists in the Documents folder before using the Open File script step to open the file. Get(DocumentsPathListing) ensures that multiple scripts can safely read from and write to the same FileMaker Pro database.
Note In FileMaker WebDirect and Custom Web Publishing, this function is not supported and returns an empty string.
Examples
For FileMaker Server, returns the following pathnames:
In Windows:
/C:/Program Files/FileMaker/FileMaker Server/Data/Documents/lastmonthsales.xlsx
/C:/Program Files/FileMaker/FileMaker Server/Data/Documents/forecastsales.xlsx
/C:/Program Files/FileMaker/FileMaker Server/Data/Documents/SAP
/C:/Program Files/FileMaker/FileMaker Server/Data/Documents/SAP/sap001.txt
/C:/Program Files/FileMaker/FileMaker Server/Data/Documents/SAP/sap002.txt
In OS X:
/Macintosh HD/Library/FileMaker Server/Data/Documents/lastmonthsales.xlsx
/Macintosh HD/Library/FileMaker Server/Data/Documents/forecastsales.xlsx
/Macintosh HD/Library/FileMaker Server/Data/Documents/SAP
/Macintosh HD/Library/FileMaker Server/Data/Documents/SAP/sap001.txt
/Macintosh HD/Library/FileMaker Server/Data/Documents/SAP/sap002.txt
Each part of the path may vary from these examples, so don't rely on the path to follow a particular pattern.
For an example script, see
Export Records script step.
Related topics