Functions Reference
Table Of Contents
- Chapter 1 Introduction
- Chapter 2 Aggregate functions
- Chapter 3 Date functions
- Chapter 4 Design functions
- Chapter 5 External functions
- Chapter 6 Financial functions
- Chapter 7 Get functions
- Get(AccountName)
- Get(ActiveFieldContents)
- Get(ActiveFieldName)
- Get(ActiveFieldTableName)
- Get(ActiveLayoutObjectName)
- Get(ActiveModifierKeys)
- Get(ActiveRepetitionNumber)
- Get(ActiveSelectionSize)
- Get(ActiveSelectionStart)
- Get(AllowAbortState)
- Get(AllowToolbarState)
- Get(ApplicationLanguage)
- Get(ApplicationVersion)
- Get(CalculationRepetitionNumber)
- Get(CurrentDate)
- Get(CurrentHostTimestamp)
- Get(CurrentTime)
- Get(CurrentTimestamp)
- Get(CustomMenuSetName)
- Get(DesktopPath)
- Get(DocumentsPath)
- Get(ErrorCaptureState)
- Get(ExtendedPrivileges)
- Get(FileMakerPath)
- Get(FileName)
- Get(FilePath)
- Get(FileSize)
- Get(FoundCount)
- Get(HighContrastColor)
- Get(HighContrastState)
- Get(HostIPAddress)
- Get(HostName)
- Get(LastError)
- Get(LastMessageChoice)
- Get(LastODBCError)
- Get(LayoutAccess)
- Get(LayoutCount)
- Get(LayoutName)
- Get(LayoutNumber)
- Get(LayoutTableName)
- Get(LayoutViewState)
- Get(MultiUserState)
- Get(NetworkProtocol)
- Get(PageNumber)
- Get(PortalRowNumber)
- Get(PreferencesPath)
- Get(PrinterName)
- Get(PrivilegeSetName)
- Get(RecordAccess)
- Get(RecordID)
- Get(RecordModificationCount)
- Get(RecordNumber)
- Get(RecordOpenCount)
- Get(RecordOpenState)
- Get(RequestCount)
- Get(RequestOmitState)
- Get(ScreenDepth)
- Get(ScreenHeight)
- Get(ScreenWidth)
- Get(ScriptName)
- Get(ScriptParameter)
- Get(ScriptResult)
- Get(SortState)
- Get(StatusAreaState)
- Get(SystemDrive)
- Get(SystemIPAddress)
- Get(SystemLanguage)
- Get(SystemNICAddress)
- Get(SystemPlatform)
- Get(SystemVersion)
- Get(TextRulerVisible)
- Get(TotalRecordCount)
- Get(UserCount)
- Get(UserName)
- Get(UseSystemFormatsState)
- Get(WindowContentHeight)
- Get(WindowContentWidth)
- Get(WindowDesktopHeight)
- Get(WindowDesktopWidth)
- Get(WindowHeight)
- Get(WindowLeft)
- Get(WindowMode)
- Get(WindowName)
- Get(WindowTop)
- Get(WindowVisible)
- Get(WindowWidth)
- Get(WindowZoomLevel)
- Chapter 8 Logical functions
- Chapter 9 Number functions
- Chapter 10 Repeating functions
- Chapter 11 Summary functions
- Chapter 12 Text functions
- Exact
- Filter
- FilterValues
- 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
- Chapter 13 Text formatting functions
- Chapter 14 Time functions
- Chapter 15 Timestamp functions
- Chapter 16 Trigonometric functions
- Appendix A Glossary
80 FileMaker Functions Reference
Get(DocumentsPath)
Format
Get(DocumentsPath)
Parameter
None
Data type returned
text
Description
Returns the path to the documents folder for the current user. In Windows, the path format
is /Drive:/Documents and Settings/UserName/My Documents/. In the Mac OS, the path
format is /DriveName/Users/UserName/Documents/.
Note See FileMaker Pro help 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.
Returns /MacintoshHD/Users/John Smith/Documents/ for a user named John Smith in
the Mac OS.
Get(ErrorCaptureState)
Format
Get(ErrorCaptureState)
Parameter
None
Data type returned
number
Description
Returns 1 if the Set Error capture script step is on; otherwise returns 0.
Note See FileMaker Pro help for information about running scripts
in client/server and
peer-to-peer environments.
Example
Returns 1 if the Set Error capture script step is on.