Get(DocumentsPath)
Purpose
Returns the path to the Documents folder for the current user.
Format
Get(DocumentsPath)
Parameters
None
Data type returned
text
Originated in
FileMaker Pro 8.0
Description
In Windows, the path format is /Drive:/Users/UserName/Documents/.
In OS X, the path format is /DriveName/Users/username/Documents/.
When running on FileMaker Server, Get(DocumentsPath) returns the location of the Documents folder, which is in the same folder as the server's Backups, Databases, and Scripts folders. The Documents folder is used as a shared location that scripts from different sessions or other processes on the machine can use to import or export files. See
FileMaker Server Help.
Note In FileMaker WebDirect and Custom Web Publishing, this function is not supported and returns an empty string.
Examples
For FileMaker Pro, for a user named John Smith, returns:
/C:/Users/John Smith/Documents/ in Windows.
/Macintosh HD/Users/johnsmith/Documents/ in OS X
For FileMaker Server, returns:
/C:/Program Files/FileMaker/FileMaker Server/Data/Documents/ in Windows.
/Macintosh HD/Library/FileMaker Server/Data/Documents/ in OS X
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
Set Variable script step.
Related topics