Functions Reference
Table Of Contents
- Contents
- Functions reference (alphabetical list)
- About functions
- Aggregate functions
- Container functions
- Date functions
- Design functions
- External functions
- Financial functions
- Get functions
- Get(AccountExtendedPrivileges)
- Get(AccountName)
- Get(AccountPrivilegeSetName)
- Get(ActiveFieldContents)
- Get(ActiveFieldName)
- Get(ActiveFieldTableName)
- Get(ActiveLayoutObjectName)
- Get(ActiveModifierKeys)
- Get(ActivePortalRowNumber)
- Get(ActiveRepetitionNumber)
- Get(ActiveSelectionSize)
- Get(ActiveSelectionStart)
- Get(AllowAbortState)
- Get(AllowFormattingBarState)
- Get(ApplicationArchitecture)
- Get(ApplicationLanguage)
- Get(ApplicationVersion)
- Get(CalculationRepetitionNumber)
- Get(ConnectionAttributes)
- Get(ConnectionState)
- Get(CurrentDate)
- Get(CurrentExtendedPrivileges)
- Get(CurrentHostTimestamp)
- Get(CurrentPrivilegeSetName)
- Get(CurrentTime)
- Get(CurrentTimestamp)
- Get(CurrentTimeUTCMilliseconds)
- Get(CustomMenuSetName)
- Get(DesktopPath)
- Get(Device)
- Get(DocumentsPath)
- Get(DocumentsPathListing)
- Get(EncryptionState)
- Get(ErrorCaptureState)
- Get(FileMakerPath)
- Get(FileName)
- Get(FilePath)
- Get(FileSize)
- Get(FoundCount)
- Get(HighContrastColor)
- Get(HighContrastState)
- Get(HostApplicationVersion)
- Get(HostIPAddress)
- Get(HostName)
- Get(InstalledFMPlugins)
- Get(LastError)
- Get(LastMessageChoice)
- Get(LastODBCError)
- Get(LayoutAccess)
- Get(LayoutCount)
- Get(LayoutName)
- Get(LayoutNumber)
- Get(LayoutTableName)
- Get(LayoutViewState)
- Get(MenubarState)
- Get(ModifiedFields)
- Get(MultiUserState)
- Get(NetworkProtocol)
- Get(NetworkType)
- Get(PageNumber)
- Get(PersistentID)
- Get(PreferencesPath)
- Get(PrinterName)
- Get(QuickFindText)
- Get(RecordAccess)
- Get(RecordID)
- Get(RecordModificationCount)
- Get(RecordNumber)
- Get(RecordOpenCount)
- Get(RecordOpenState)
- Get(RequestCount)
- Get(RequestOmitState)
- Get(ScreenDepth)
- Get(ScreenHeight)
- Get(ScreenScaleFactor)
- Get(ScreenWidth)
- Get(ScriptAnimationState)
- Get(ScriptName)
- Get(ScriptParameter)
- Get(ScriptResult)
- Get(SortState)
- Get(StatusAreaState)
- Get(SystemDrive)
- Get(SystemIPAddress)
- Get(SystemLanguage)
- Get(SystemNICAddress)
- Get(SystemPlatform)
- Get(SystemVersion)
- Get(TemporaryPath)
- Get(TextRulerVisible)
- Get(TotalRecordCount)
- Get(TouchKeyboardState)
- Get(TriggerCurrentPanel)
- Get(TriggerExternalEvent)
- Get(TriggerGestureInfo)
- Get(TriggerKeystroke)
- Get(TriggerModifierKeys)
- Get(TriggerTargetPanel)
- Get(UserCount)
- Get(UserName)
- Get(UseSystemFormatsState)
- Get(UUID)
- Get(WindowContentHeight)
- Get(WindowContentWidth)
- Get(WindowDesktopHeight)
- Get(WindowDesktopWidth)
- Get(WindowHeight)
- Get(WindowLeft)
- Get(WindowMode)
- Get(WindowName)
- Get(WindowOrientation)
- Get(WindowStyle)
- Get(WindowTop)
- Get(WindowVisible)
- Get(WindowWidth)
- Get(WindowZoomLevel)
- Logical functions
- Mobile functions
- Number functions
- Repeating functions
- Summary functions
- Text functions
- Char
- Code
- Exact
- Filter
- FilterValues
- Furigana
- GetAsCSS
- GetAsDate
- GetAsNumber
- GetAsSVG
- GetAsText
- GetAsTime
- GetAsTimestamp
- GetAsURLEncoded
- GetValue
- Hiragana
- KanaHankaku
- KanaZenkaku
- KanjiNumeral
- Katakana
- Left
- LeftValues
- LeftWords
- Length
- Lower
- Middle
- MiddleValues
- MiddleWords
- NumToJText
- PatternCount
- Position
- Proper
- Quote
- Replace
- Right
- RightValues
- RightWords
- RomanHankaku
- RomanZenkaku
- SerialIncrement
- Substitute
- Trim
- TrimAll
- Upper
- ValueCount
- WordCount
- Text formatting functions
- Time functions
- Timestamp functions
- Trigonometric functions
- Glossary
Get functions
F
ILEMAKER FUNCTIONS REFERENCE 134
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. For more information, 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