Home > Reference > Functions reference > Get functions

Get functions

Use Get functions in scripts for error checking and prevention, or to capture information about the status of a database file or elements in it, or an action being performed.

Many Get functions return information that changes on a regular basis. For example, when the Get(CurrentTime) function is placed in a stored calculation field, the time will only update when a new record is created. If the calculation has other fields in it, but the calculation result still returns the current time, then the stored calculation result will only update when those other fields have been modified in the current record. If either of these calculations are unstored, the time will update as needed. For performance reasons, making a calculation field unstored is not always the best idea. Get functions are best used in a script where the status information from a Get function is up to date at the moment that the calculation is run.

To access the list of Get functions, in the Specify Calculation dialog box, choose View all functions by type or View Get functions. When you choose View all functions by name, you see only Get(flag).

Note  For information on how functions evaluate differently on the host versus the client, search the FileMaker Knowledge Base available at http://help.filemaker.com.

Click a function name for details.

 

This function	Returns
Get(AccountExtendedPrivileges)	A list of keywords for the enabled extended privileges, separated by carriage returns. The list that is returned is based on the account used to open the database file.
Get(AccountName)	The authenticated account name being used for the active database file.
Get(AccountPrivilegeSetName)	The name of the privilege set that is being used by the account used to open the database file.
Get(ActiveFieldContents)	The contents of the field that has the focus.
Get(ActiveFieldName)	The name of the field that has the focus.
Get(ActiveFieldTableName)	The name of the table that contains the active field (the field that has the focus).
Get(ActiveLayoutObjectName)	The name of the active layout object in the calculation's active window.
Get(ActiveModifierKeys)	A number representing the keyboard modifier keys (for example, Shift) that are being pressed.
Get(ActivePortalRowNumber)	The number of the portal row containing the focus.
Get(ActiveRepetitionNumber)	A number representing the active repetition of a repeating field (the repetition that has the focus).
Get(ActiveSelectionSize)	A number representing how many characters are selected.
Get(ActiveSelectionStart)	A number representing the starting character of the selected text.
Get(AllowAbortState)	A Boolean value representing the current state of Allow user abort script step.
Get(AllowFormattingBarState)	A Boolean value representing whether toolbars are allowed to be visible.
Get(ApplicationLanguage)	Text representing the current application language (for example, English).
Get(ApplicationVersion)	Text representing the FileMaker application version.
Get(CalculationRepetitionNumber)	A number representing the repetition of the calculation field that is currently being calculated.
Get(ConnectionState)	A number representing the security state of the network connection for the current file.
Get(CurrentDate)	The current date according to the system calendar.
Get(CurrentExtendedPrivileges)	A list of keywords for the enabled extended privileges of the account that is being used to evaluate the calculation.
Get(CurrentHostTimestamp)	The host's current date and time (to the nearest second) according to the system clock.
Get(CurrentPrivilegeSetName)	The name of the privilege set that is being used to evaluate this calculation in the database.
Get(CurrentTime)	The current time (to the nearest second) according to the system clock.
Get(CurrentTimestamp)	The current date and time (to the nearest second) according to the system clock.
Get(CustomMenuSetName)	The name of the active custom menu set.
Get(DesktopPath)	The path to the desktop folder for the current user.
Get(DocumentsPath)	The path to the Documents folder for the current user.
Get(DocumentsPathListing)	A list of all the files and folders in the Documents folder returned by the Get(DocumentsPath) function.
Get(ErrorCaptureState)	A Boolean value representing the state of Error capture script step.
Get(FileMakerPath)	The path to the folder of the currently running copy of FileMaker Pro.
Get(FileName)	The name of the currently active database file.
Get(FilePath)	The full path indicating the location of the file.
Get(FileSize)	The size (in bytes) of the currently active database file.
Get(FoundCount)	A number that represents the number of records in the current found set.
Get(HighContrastColor)	The name of the current high contrast default color scheme if Use High Contrast is selected in the Windows operating system Accessibility Options dialog box.
Get(HighContrastState)	A Boolean value representing the state of the Use High Contrast checkbox on the Accessibility Options dialog box.
Get(HostApplicationVersion)	The version of FileMaker Pro or FileMaker Server running on the computer that is hosting the current database.
Get(HostIPAddress)	The IP address of the host machine for the current database.
Get(HostName)	The registered name of the computer that is hosting the database file.
Get(InstalledFMPlugins)	The display name, version number (if available), and enabled state of installed plug-ins.
Get(LastError)	A number representing the error, if any, in the execution of the most recently executed script step.
Get(LastMessageChoice)	A number corresponding to the button clicked in an alert message displayed by the Show Custom Dialog script step.
Get(LastODBCError)	A string that shows the error state published by ODBC standards, based on ISO/IEF standards.
Get(LayoutAccess)	A number corresponding to the layout access privileges assigned through the Manage Security dialog box.
Get(LayoutCount)	The total number of layouts in the database file.
Get(LayoutName)	The name of the layout currently displayed.
Get(LayoutNumber)	The number of the layout currently displayed, according to the list in the Manage Layouts dialog box.
Get(LayoutTableName)	The name of the table that the layout is displaying records from.
Get(LayoutViewState)	Information about how the database file is being viewed.
Get(MultiUserState)	A number representing the current multi-user state of the database file.
Get(NetworkProtocol)	The name of the network protocol that FileMaker Pro is using on this machine.
Get(PageNumber)	A number representing the current page being printed or previewed.
Get(PersistentID)	Text representing a unique identifier of the computer or device on which FileMaker is running.
Get(PreferencesPath)	The path to the preferences folder for the current user.
Get(PrinterName)	A string identifying the default printer name.
Get(QuickFindText)	The text that was entered in the Quick Find box.
Get(RecordAccess)	A number indicating the access privileges of the current record.
Get(RecordID)	The unique ID number of the current record.
Get(RecordModificationCount)	The total number of times changes to the current record have been committed.
Get(RecordNumber)	The number of the current record in the current found set.
Get(RecordOpenCount)	The total number of open records in the current found set that haven’t yet been saved.
Get(RecordOpenState)	A number representing the state of the current record.
Get(RequestCount)	The total number of find requests currently defined for the current table.
Get(RequestOmitState)	A Boolean value representing the state of the Omit checkbox in Find mode.
Get(ScreenDepth)	The number of bits needed to represent the color or shade of gray of a pixel on the main screen.
Get(ScreenHeight)	The number of pixels displayed vertically on the screen in which the window of the current file is open.
Get(ScreenWidth)	The number of pixels displayed horizontally on the screen in which the window of the current file is open.
Get(ScriptName)	The name of the script currently running (or paused).
Get(ScriptParameter)	The script parameter passed into the current script.
Get(ScriptResult)	The script result from a performed subscript.
Get(SortState)	A number value representing the current sort state.
Get(StatusAreaState)	A number representing whether the status toolbar is hidden, visible, visible and locked, or hidden and locked.
Get(SystemDrive)	The drive letter (Windows) or the volume name (Mac OS) where the currently running operating system is located.
Get(SystemIPAddress)	The IP addresses of all the machines connected to a NIC (Network Interface Controller) card.
Get(SystemLanguage)	The language currently set on the current system.
Get(SystemNICAddress)	The hardware addresses of all the Network Interface Controller cards connected to the machine.
Get(SystemPlatform)	A number indicating the current platform.
Get(SystemVersion)	The version of the operating system of the machine on which the function is executed.
Get(TemporaryPath)	The path to the current user’s temporary folder used by FileMaker Pro.
Get(TextRulerVisible)	A Boolean value representing whether or not the text ruler is visible.
Get(TotalRecordCount)	The total number of records in the current table.
Get(TriggerCurrentTabPanel)	The index number and object name of the tab panel to be switched from when the OnTabSwitch script trigger is activated.
Get(TriggerKeystroke)	A string containing the characters that activated an OnObjectKeystroke or OnLayoutKeystroke script trigger.
Get(TriggerModifierKeys)	The state of the keyboard modifier keys as they were when the script trigger was activated.
Get(TriggerTargetTabPanel)	The index number and object name of the tab panel to be switched to when the OnTabSwitch script trigger is activated.
Get(UserCount)	The number of users who are currently accessing the file.
Get(UserName)	The name of the FileMaker Pro user, as specified in the General tab of the Preferences dialog box.
Get(UseSystemFormatsState)	A Boolean value representing the state of the Use System Formats menu command.
Get(UUID)	Text representing a Universally Unique Identifier (UUID).
Get(WindowContentHeight)	A number representing the height, in pixels, of the content area.
Get(WindowContentWidth)	A number representing the width, in pixels, of the content area.
Get(WindowDesktopHeight)	A number representing the height, in pixels, of the desktop space.
Get(WindowDesktopWidth)	A number representing the width, in pixels, of the desktop space.
Get(WindowHeight)	A number representing the height, in pixels, of the current window of the file in which the calculation is defined.
Get(WindowLeft)	A number representing the horizontal distance, in pixels, of the outer edge of the current window relative to the left-most edge of the screen.
Get(WindowMode)	A number representing whether FileMaker Pro is in Browse mode, Find mode, Preview mode, or printing when the function is evaluated.
Get(WindowName)	The name of the current window of the file in which the calculation is defined.
Get(WindowStyle)	A number indicating whether the top-most open window is a document window, a floating document window, or a dialog window.
Get(WindowTop)	A number representing the vertical distance, in pixels, of the outer edge of the current window relative to the bottom edge of the menu bar.
Get(WindowVisible)	A Boolean value representing whether or not the current window is visible.
Get(WindowWidth)	A number representing the width, in pixels, of the current window of the file in which the calculation is defined.
Get(WindowZoomLevel)	The zoom level of the current window.

Get functions example

This script uses the function Get(CurrentDate) to check each record in the found set to see if an account is past due. If an account is past due, the script shows a message and prompts the user to click a button labeled Ignore, Send Letter, or Send Mail (set up through the Show Custom Dialog script step). The script captures the user's response using Get(LastMessageChoice). Then, based on the user's response, the script performs an action: it cancels the rest of the script, prints a "payment is late" letter, or sends email to the associated account.

 

Go to Layout ["LayoutName"]

Go to Record/Request/Page [First]

Loop

  If [DatabaseName::Date < Get(CurrentDate) - 30]

    Show Custom Dialog ["30 or more days late"]

    If [Get(LastMessageChoice) = 1]

      Halt Script

    Else If [Get(LastMessageChoice) = 2]

      Go to Layout ["Late Notice"]

      Print []

    Else

      Send Mail [To: DatabaseName::Client; Subject: "Late Notice"; Message: "Your account is past due."]

    End If

  End If

  Go to Record/Request/Page [Exit after last, Next]

End Loop

Go to Layout [original layout]