Get(DocumentsPath) function

Contents > Functions reference (alphabetical list) > Get functions > Get(DocumentsPath) function

Get(DocumentsPath) function

Format


Get(DocumentsPath)

Parameter

None

Data type returned

text

Description

Returns the path to the documents folder for the current user. In Windows XP, the path format is /Drive:/Documents and Settings/UserName/My Documents/. In Windows Vista, the path format is /Drive:/Users/UserName/Documents/. In the Mac OS, the path format is /DriveName/Users/UserName/Documents/.

Note See Solving calculations on a host machine for information about running scripts in client/server and peer-to-peer environments.

Examples

Returns /C:/Documents and Settings/John Smith/My Documents/ for a user named John Smith in Windows XP.

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

Returns /MacintoshHD/Users/John Smith/Documents/ for a user named John Smith in the Mac OS.

Related topics

Functions reference (category list)

Functions reference (alphabetical list)

About formulas

About functions

Defining calculation fields

Using operators in formulas

Contents > Functions reference (alphabetical list) > Get functions > Get(DocumentsPath) function