Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

Component: Plugin

Central plugin management functions.

Version macOS Windows Linux Server iOS SDK
1.0 / 14.3 ✅ Yes ✅ 97% ✅ 99% ✅ 97% ✅ 99%

Item Details Server
AddToErrorLog
Adds log entry to current error log.
All
12.3
  ✅ Server
ClearErrors
Clears error counter.
All
12.2
  ✅ Server
ClearRegistration
Clears registration details stored with StoreRegistration.
All
3.0
  ✅ Server
CompileDate
Returns the date the plug-in was compiled.
All
1.0
  ✅ Server
CompileTime
The time of day that the plug-in was compiled.
All
1.0
  ✅ Server
ErrorLog
Queries error log.
All
12.3
  ✅ Server
HadErrors
Queries error counter.
All
12.2
  ✅ Server
Is64bit
Checks if platform is 64bit or 32bit.
All
5.0
  ✅ Server
IsClient
Checks if plugin is running on a client.
All
4.3
  ✅ Server
IsError
Checks whether last plugin function returned error.
All
3.4
  ✅ Server
IsIOS
Whether we run on iOS.
All
6.1
  ✅ Server
IsIOSDevice
Queries whether run on iOS device.
All
8.0
  ✅ Server
IsIOSSimulator
Queries whether run on iOS simulator.
All
8.0
  ✅ Server
IsLinux
Whether we run on Linux.
All
6.1
  ✅ Server
IsMacOS
Whether we run on Mac.
All
6.1
  ✅ Server
IsMobile
Whether plugin runs on a mobile target.
All
7.2
  ✅ Server
IsRegistered
Queries if plugin is registered with Complete key.
All
3.0
  ✅ Server
IsRuntime
Checks if plugin is running on a runtime.
All
4.3
  ✅ Server
IsServer
Checks if plugin is running on a server.
All
4.3
  ✅ Server
IsWindows
Whether we run on Windows.
All
6.1
  ✅ Server
Platform
Returns what platform the plugin is running on.
All
3.0
  ✅ Server
Plugin.BuildNumber
Queries the build number of the plugin.
All
5.0
  ✅ Server
Plugin.CallCounter
Queries call counter.
All
9.3
  ✅ Server
Plugin.CallErrorScriptTrigger
Triggers error script.
All
8.5
  ❌ Server
Plugin.CompileDate
Queries compile date as FileMaker date.
All
10.0
  ✅ Server
Plugin.DisableFunction
Disables a plugin function.
All
2.8
  ✅ Server
Plugin.FunctionCount
Queries number of functions available.
All
7.2
  ✅ Server
Plugin.Functions
Returns a list of all the functions in the plugin.
All
1.0
  ✅ Server
Plugin.GetFunctionParameters
Queries the function metadata for parameter list.
All
12.1
  ✅ Server
Plugin.GetFunctionPlatforms
Queries the function metadata for platform support.
All
10.5
  ✅ Server
Plugin.GetSuccessReturn
Queries current OK return.
All
5.1
  ✅ Server
Plugin.InstallSignalHandlers
Installs signal handlers.
Mac/Linux/iOS
9.3
  ✅ Server
Plugin.IsLicenseKeyHidden   New in 14.3
Queries whether to hide license key.
All
14.3
  ✅ Server
Plugin.IsMaintenanceExpired
Queries whether maintenance is expired.
All
13.1
  ✅ Server
Plugin.IsPrerelease
Queries whether this is a MBS Plugin beta version.
All
10.0
  ✅ Server
Plugin.JasperVersion
Queries version string for Jasper library.
All
9.0
  ✅ Server
Plugin.LibSSHVersion
Queries the SSH library version used.
All
6.2
  ✅ Server
Plugin.LicenseeName
Queries licensee name.
All
8.3
  ✅ Server
Plugin.LimitFunction
Limits a function.
All
5.4
  ✅ Server
Plugin.LoadIconvLibrary
Loads the iconv library.
All
10.4
  ✅ Server
Plugin.LockFunction
Locks a function with a password.
All
5.4
  ✅ Server
Plugin.LockedFunctions   New in 14.3
Lists the locked functions.
All
14.3
  ✅ Server
Plugin.ObjectCounts
Returns JSON with object counts.
All
13.5
  ✅ Server
Plugin.OpenSSLVersion
Queries OpenSSL Version.
All
6.2
  ✅ Server
Plugin.PNGVersion
Queries PNG version.
All
7.3
  ✅ Server
Plugin.Path
Queries the native file path to the plugin.
All
3.3
  ✅ Server
Plugin.ScriptStepParameter
Queries script step parameter with given index.
All
7.2
  ✅ Server
Plugin.ScriptStepParameterCount
Queries number of parameters to the current script step.
All
7.2
  ✅ Server
Plugin.Seats
Queries the internal seats value.
All
1.6
  ✅ Server
Plugin.SetErrorScriptTrigger
Sets script to trigger if plugin call returns an error.
All
8.5
  ❌ Server
Plugin.SetFunctions
Sets the function list the plugin has.
All
5.1
  ✅ Server
Plugin.SetLicenseKeyHidden   New in 14.3
Sets whether to hide license key.
All
14.3
  ✅ Server
Plugin.SetPreviewSize
Sets which size plugin uses for preview images.
All
5.1
  ✅ Server
Plugin.SetSuccessReturn
Sets what the plugin returns on success.
All
5.1
  ✅ Server
Plugin.StartTimeStamp
Queries time the plugin was loaded.
All
9.5
  ✅ Server
Plugin.State
Queries plugin state.
All
13.1
  ✅ Server
Plugin.TiffVersion
Queries version string for TIFF library.
All
9.0
  ✅ Server
Plugin.UnlockFunction
Unlocks a locked function.
All
5.4
  ✅ Server
Plugin.UsedFunctionCounts
Queries plugin function usage counts.
All
13.5
  ✅ Server
Plugin.UsedFunctions
Queries used functions.
All
8.3
  ✅ Server
Plugin.WebPVersion
Returns version of WebP library.
All
13.2
  ✅ Server
Plugin.ZLibVersion
Queries zlib version number.
All
8.1
  ✅ Server
Plugin.isDebug
Checks whether this is debug version of MBS Plugin.
All
7.1
  ✅ Server
Register
This function is used to register the Plugin.
All
1.0
  ✅ Server
Registration
Returns a list of the currently registered components.
All
1.0
  ✅ Server
StoreRegistration
Stores registration on Mac in preferences file of FileMaker so the plugin can auto register itself on startup of FileMaker.
All
3.0
  ✅ Server
Unregister
Unregisters the plugin license.
All
1.6
  ✅ Server
Version
Useful for doing auto-updates from server and version checking.
All
1.0
  ✅ Server
VersionAutoUpdate
Returns the version in the auto update format. e.g. 02040028
All
2.4
  ✅ Server

69 functions shown.

These functions are free to use.

Release notes

Blog Entries

FileMaker Magazin

Example Databases