Get(DesktopPath)

Reference > Functions reference > Get functions > Get(DesktopPath)

Get(DesktopPath)

Purpose

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

Format

Get(DesktopPath)

Parameters

None

Data type returned

text

Originated in

FileMaker Pro 8.0

Description

In Windows, the path format is /Drive:/Users/UserName/Desktop/.

In OS X, the path format is /DriveName/Users/username/Desktop/.

Notes

•In FileMaker Server scripts, the Desktop folder is not supported, so this function returns unreliable results. Instead, paths must use the FileMaker Server Documents folder or temporary folder. See Get(DocumentsPath) function or Get(TemporaryPath) function.

•In FileMaker WebDirect, this function is not supported and returns an empty string.

Examples

Returns /C:/Users/John Smith/Desktop/ for a user named John Smith in Windows.

Returns /Macintosh HD/Users/johnsmith/Desktop/ for a user named John Smith 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 Get Directory script step.