Get(DocumentsPath)

Returns the path to the Documents folder for the current user.

Format 

Get ( DocumentsPath )

Parameters 

None

Data type returned 

text

Originated in version 

8.0

Description 

In FileMaker Pro and FileMaker Go, returns the path to the current user's Documents folder. The path format varies by operating system.

When running on server-side scripts, Get(DocumentsPath) returns the location of the Documents folder. 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 or FileMaker Cloud Help.

Notes 

  • In FileMaker WebDirect, the FileMaker Data API, and Custom Web Publishing, this function is not supported and returns an empty string.

  • The returned path is in FileMaker format but doesn't include a path prefix. See About path prefixes.

Example 1 

For FileMaker Pro, for a user named John Smith, returns:

/C:/Users/John Smith/Documents/ in Windows

/Macintosh HD/Users/johnsmith/Documents/ in macOS

For FileMaker Server, returns:

/C:/Program Files/FileMaker/FileMaker Server/Data/Documents/ in Windows

/Macintosh HD/Library/FileMaker Server/Data/Documents/ in macOS

For FileMaker Cloud, returns:

/opt/FileMaker/FileMaker Server/Data/Documents/

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