Component: Plugin 
------------------

Central plugin management functions.

| Version | macOS | Windows | Linux | Server | iOS SDK |
|---|---|---|---|---|---|
| [1.0](newinversion10.md "First functions introduced with version 1.0.") / [15.5](newinversion155.md "Newest functions in version 15.5.") | ✅ Yes | ✅ 98% | ✅ 99% | ✅ 98% | ✅ 99% |

  
| Item | Details | Server |
|:--|:--|:--|
| [AddToErrorLog](AddToErrorLog.md)   Adds log entry to current error log. | All   12.3 | ✅ Server |
| [ClearErrors](ClearErrors.md)   Clears error counter. | All   12.2 | ✅ Server |
| [ClearRegistration](ClearRegistration.md)   Clears registration details stored with StoreRegistration. | All   3.0 | ✅ Server |
| [CompileDate](CompileDate.md)   Returns the date the plug-in was compiled. | All   1.0 | ✅ Server |
| [CompileTime](CompileTime.md)   The time of day that the plug-in was compiled. | All   1.0 | ✅ Server |
| [ErrorLog](ErrorLog.md)   Queries error log. | All   12.3 | ✅ Server |
| [HadErrors](HadErrors.md)   Queries error counter. | All   12.2 | ✅ Server |
| [Is64bit](Is64bit.md)   Checks if platform is 64bit or 32bit. | All   5.0 | ✅ Server |
| [IsClient](IsClient.md)   Checks if plugin is running on a client. | All   4.3 | ✅ Server |
| [IsError](IsError.md)   Checks whether last plugin function returned error. | All   3.4 | ✅ Server |
| [IsIOS](IsIOS.md)   Whether we run on iOS. | All   6.1 | ✅ Server |
| [IsIOSDevice](IsIOSDevice.md)   Queries whether run on iOS device. | All   8.0 | ✅ Server |
| [IsIOSSimulator](IsIOSSimulator.md)   Queries whether run on iOS simulator. | All   8.0 | ✅ Server |
| [IsLinux](IsLinux.md)   Whether we run on Linux. | All   6.1 | ✅ Server |
| [IsMacOS](IsMacOS.md)   Whether we run on Mac. | All   6.1 | ✅ Server |
| [IsMobile](IsMobile.md)   Whether plugin runs on a mobile target. | All   7.2 | ✅ Server |
| [IsRegistered](IsRegistered.md)   Queries if plugin is registered with Complete key. | All   3.0 | ✅ Server |
| [IsRuntime](IsRuntime.md)   Checks if plugin is running on a runtime. | All   4.3 | ✅ Server |
| [IsServer](IsServer.md)   Checks if plugin is running on a server. | All   4.3 | ✅ Server |
| [IsWindows](IsWindows.md)   Whether we run on Windows. | All   6.1 | ✅ Server |
| [Platform](Platform.md)   Returns what platform the plugin is running on. | All   3.0 | ✅ Server |
| [Plugin.BuildNumber](PluginBuildNumber.md)   Queries the build number of the plugin. | All   5.0 | ✅ Server |
| [Plugin.CallCounter](PluginCallCounter.md)   Queries call counter. | All   9.3 | ✅ Server |
| [Plugin.CallErrorScriptTrigger](PluginCallErrorScriptTrigger.md)   Triggers error script. | All   8.5 | ❌ Server |
| [Plugin.CompileDate](PluginCompileDate.md)   Queries compile date as FileMaker date. | All   10.0 | ✅ Server |
| [Plugin.CustomFunctionIDs](PluginCustomFunctionIDs.md)   Queries the list of registered function ids. | All   15.5 | ✅ Server |
| [Plugin.CustomFunctionNames](PluginCustomFunctionNames.md)   Queries list of function names. | All   15.3 | ✅ Server |
| [Plugin.CustomFunctionParameter](PluginCustomFunctionParameter.md)   Queries custom function parameter with given index. | All   15.3 | ✅ Server |
| [Plugin.CustomFunctionParameterCount](PluginCustomFunctionParameterCount.md)   Queries number of parameters to the current custom function. | All   15.3 | ✅ Server |
| [Plugin.CustomFunctions](PluginCustomFunctions.md)   Queries details on all registered custom functions. | All   15.5 | ✅ Server |
| [Plugin.DisableFunction](PluginDisableFunction.md)   Disables a plugin function. | All   2.8 | ✅ Server |
| [Plugin.FunctionCount](PluginFunctionCount.md)   Queries number of functions available. | All   7.2 | ✅ Server |
| [Plugin.Functions](PluginFunctions.md)   Returns a list of all the functions in the plugin. | All   1.0 | ✅ Server |
| [Plugin.GetFunctionParameters](PluginGetFunctionParameters.md)   Queries the function metadata for parameter list. | All   12.1 | ✅ Server |
| [Plugin.GetFunctionPlatforms](PluginGetFunctionPlatforms.md)   Queries the function metadata for platform support. | All   10.5 | ✅ Server |
| [Plugin.GetSuccessReturn](PluginGetSuccessReturn.md)   Queries current OK return. | All   5.1 | ✅ Server |
| [Plugin.InstallSignalHandlers](PluginInstallSignalHandlers.md)   Installs signal handlers. | Mac/Linux/iOS   9.3 | ✅ Server |
| [Plugin.IsLicenseKeyHidden](PluginIsLicenseKeyHidden.md)   Queries whether to hide license key. | All   14.3 | ✅ Server |
| [Plugin.IsMaintenanceExpired](PluginIsMaintenanceExpired.md)   Queries whether maintenance is expired. | All   13.1 | ✅ Server |
| [Plugin.IsPrerelease](PluginIsPrerelease.md)   Queries whether this is a MBS Plugin beta version. | All   10.0 | ✅ Server |
| [Plugin.JasperVersion](PluginJasperVersion.md)   Queries version string for Jasper library. | All   9.0 | ✅ Server |
| [Plugin.LibExpatVersion](PluginLibExpatVersion.md)   Queries the version of the expat library. | All   15.0 | ✅ Server |
| [Plugin.LibSSHVersion](PluginLibSSHVersion.md)   Queries the SSH library version used. | All   6.2 | ✅ Server |
| [Plugin.LicenseeName](PluginLicenseeName.md)   Queries licensee name. | All   8.3 | ✅ Server |
| [Plugin.LimitFunction](PluginLimitFunction.md)   Limits a function. | All   5.4 | ✅ Server |
| [Plugin.LimitToFile](PluginLimitToFile.md)   Sets which files are allowed to use our plugin. | All   15.1 | ✅ Server |
| [Plugin.LoadIconvLibrary](PluginLoadIconvLibrary.md)   Loads the iconv library. | All   10.4 | ✅ Server |
| [Plugin.LockFunction](PluginLockFunction.md)   Locks a function with a password. | All   5.4 | ✅ Server |
| [Plugin.LockedFunctions](PluginLockedFunctions.md)   Lists the locked functions. | All   14.3 | ✅ Server |
| [Plugin.ObjectCounts](PluginObjectCounts.md)   Returns JSON with object counts. | All   13.5 | ✅ Server |
| [Plugin.OpenSSLVersion](PluginOpenSSLVersion.md)   Queries OpenSSL Version. | All   6.2 | ✅ Server |
| [Plugin.PNGVersion](PluginPNGVersion.md)   Queries PNG version. | All   7.3 | ✅ Server |
| [Plugin.Path](PluginPath.md)   Queries the native file path to the plugin. | All   3.3 | ✅ Server |
| [Plugin.RegisterFunction](PluginRegisterFunction.md)   Registers a custom function with FileMaker or JavaScript code. | All   15.3 | ✅ Server |
| [Plugin.RegisterScriptStep](PluginRegisterScriptStep.md)   Registers a script step dynamically. | All   15.3 | ✅ Server |
| [Plugin.ScriptStepParameter](PluginScriptStepParameter.md)   Queries script step parameter with given index. | All   7.2 | ✅ Server |
| [Plugin.ScriptStepParameterCount](PluginScriptStepParameterCount.md)   Queries number of parameters to the current script step. | All   7.2 | ✅ Server |
| [Plugin.Seats](PluginSeats.md)   Queries the internal seats value. | All   1.6 | ✅ Server |
| [Plugin.SetErrorScriptTrigger](PluginSetErrorScriptTrigger.md)   Sets script to trigger if plugin call returns an error. | All   8.5 | ❌ Server |
| [Plugin.SetFunctions](PluginSetFunctions.md)   Sets the function list the plugin has. | All   5.1 | ✅ Server |
| [Plugin.SetLicenseKeyHidden](PluginSetLicenseKeyHidden.md)   Sets whether to hide license key. | All   14.3 | ✅ Server |
| [Plugin.SetPreviewSize](PluginSetPreviewSize.md)   Sets which size plugin uses for preview images. | All   5.1 | ✅ Server |
| [Plugin.SetSuccessReturn](PluginSetSuccessReturn.md)   Sets what the plugin returns on success. | All   5.1 | ✅ Server |
| [Plugin.StartTimeStamp](PluginStartTimeStamp.md)   Queries time the plugin was loaded. | All   9.5 | ✅ Server |
| [Plugin.State](PluginState.md)   Queries plugin state. | All   13.1 | ✅ Server |
| [Plugin.TiffVersion](PluginTiffVersion.md)   Queries version string for TIFF library. | All   9.0 | ✅ Server |
| [Plugin.UnlockFunction](PluginUnlockFunction.md)   Unlocks a locked function. | All   5.4 | ✅ Server |
| [Plugin.UnregisterFunction](PluginUnregisterFunction.md)   Unregister a function. | All   15.4 | ✅ Server |
| [Plugin.UnregisterScriptStep](PluginUnregisterScriptStep.md)   Unregister a script step. | All   15.4 | ✅ Server |
| [Plugin.UsedFunctionCounts](PluginUsedFunctionCounts.md)   Queries plugin function usage counts. | All   13.5 | ✅ Server |
| [Plugin.UsedFunctions](PluginUsedFunctions.md)   Queries used functions. | All   8.3 | ✅ Server |
| [Plugin.WebPVersion](PluginWebPVersion.md)   Returns version of WebP library. | All   13.2 | ✅ Server |
| [Plugin.ZLibVersion](PluginZLibVersion.md)   Queries zlib version number. | All   8.1 | ✅ Server |
| [Plugin.isDebug](PluginisDebug.md)   Checks whether this is debug version of MBS Plugin. | All   7.1 | ✅ Server |
| [Register](Register.md)   This function is used to register the Plugin. | All   1.0 | ✅ Server |
| [Registration](Registration.md)   Returns a list of the currently registered components. | All   1.0 | ✅ Server |
| [StoreRegistration](StoreRegistration.md)   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](Unregister.md)   Unregisters the plugin license. | All   1.6 | ✅ Server |
| [Version](Version.md)   Useful for doing auto-updates from server and version checking. | All   1.0 | ✅ Server |
| [VersionAutoUpdate](VersionAutoUpdate.md)   Returns the version in the auto update format. e.g. 02040028 | All   2.4 | ✅ Server |

80 functions shown.

### Release notes

- **Version 15.5**
    - Added flag 8 for [Plugin.RegisterFunction](https://www.mbsplugins.eu/PluginRegisterFunction.shtml) function to secure a function and prevent unregister or replacement.
    - Added [Plugin.CustomFunctionIDs](https://www.mbsplugins.eu/PluginCustomFunctionIDs.shtml) function to query IDs of custom functions.
    - Added [Plugin.CustomFunctions](https://www.mbsplugins.eu/PluginCustomFunctions.shtml) function to query JSON with details about custom functions.
    - Fixed [Plugin.CustomFunctionIDs](https://www.mbsplugins.eu/PluginCustomFunctionIDs.shtml) function to return correct IDs.
    - Fixed [Plugin.RegisterFunction](https://www.mbsplugins.eu/PluginRegisterFunction.shtml) to handle optional parameters better and create temporary variables for the calculations.
- **Version 15.4**
    - Added flags for [Plugin.RegisterFunction](https://www.mbsplugins.eu/PluginRegisterFunction.shtml)and [Plugin.RegisterScriptStep](https://www.mbsplugins.eu/PluginRegisterScriptStep.shtml) functions, so you can turn on JavaScript.
    - Added [Plugin.UnregisterFunction](https://www.mbsplugins.eu/PluginUnregisterFunction.shtml) and [Plugin.UnregisterScriptStep](https://www.mbsplugins.eu/PluginUnregisterScriptStep.shtml) functions.
    - Improved custom functions with [Plugin.RegisterFunction](https://www.mbsplugins.eu/PluginRegisterFunction.shtml) to handle optional parameters better. Use {} in the parameters to declare optional ones.
    - Improved custom functions with [Plugin.RegisterFunction](https://www.mbsplugins.eu/PluginRegisterFunction.shtml) to properly pass through errors, so Get(LastError) can see it.
- **Version 15.3**
    - Added [Plugin.CustomFunctionNames](https://www.mbsplugins.eu/PluginCustomFunctionNames.shtml) to list custom functions.
    - Added [Plugin.CustomFunctionParameter](https://www.mbsplugins.eu/PluginCustomFunctionParameter.shtml) and [Plugin.CustomFunctionParameterCount](https://www.mbsplugins.eu/PluginCustomFunctionParameterCount.shtml) to query parameters for the custom function.
    - Added [Plugin.RegisterFunction](https://www.mbsplugins.eu/PluginRegisterFunction.shtml) function to register custom functions on the fly. These show up in calculation dialogs just like regular custom functions.
    - Added [Plugin.RegisterScriptStep](https://www.mbsplugins.eu/PluginRegisterScriptStep.shtml) function.
    - Improved [Plugin.RegisterFunction](https://www.mbsplugins.eu/PluginRegisterFunction.shtml) to pass parameters as they appear in prototype.
- **Version 15.1**
    - Added [Plugin.LimitToFile](https://www.mbsplugins.eu/PluginLimitToFile.shtml) function.
- **Version 15.0**
    - Added FileNames parameter for [Plugin.LimitFunction](https://www.mbsplugins.eu/PluginLimitFunction.shtml) function.
    - Added [Plugin.LibExpatVersion](https://www.mbsplugins.eu/PluginLibExpatVersion.shtml) function.
- **Version 14.3**
    - Added [Plugin.LockedFunctions](https://www.mbsplugins.eu/PluginLockedFunctions.shtml) function.
    - Added [Plugin.SetLicenseKeyHidden](https://www.mbsplugins.eu/PluginSetLicenseKeyHidden.shtml) and [Plugin.IsLicenseKeyHidden](https://www.mbsplugins.eu/PluginIsLicenseKeyHidden.shtml) functions.
- **Version 13.5**
    - Added [Plugin.ObjectCounts](https://www.mbsplugins.eu/PluginObjectCounts.shtml) and [Plugin.UsedFunctionCounts](https://www.mbsplugins.eu/PluginUsedFunctionCounts.shtml) function.
- **Version 13.2**
    - Added [Plugin.WebPVersion](https://www.mbsplugins.eu/PluginWebPVersion.shtml) function.
- **Version 13.1**
    - Added [Plugin.IsMaintenanceExpired](https://www.mbsplugins.eu/PluginIsMaintenanceExpired.shtml) function.
    - Added [Plugin.State](https://www.mbsplugins.eu/PluginState.shtml) function.

### Blog Entries

- [Free Tier for MBS FileMaker Plugin](https://www.mbsplugins.de/archive/2023-01-30/Free_Tier_for_MBS_FileMaker_Pl/monkeybreadsoftware_blog_filemaker)

### FileMaker Magazin

- [Ausgabe 2/2026, Seite 33](https://filemaker-magazin.de/neuigkeit/4318-Die-neue-Ausgabe-FMM_202602-steht-online)
- [Ausgabe 2/2026, Seite 31](https://filemaker-magazin.de/neuigkeit/4318-Die-neue-Ausgabe-FMM_202602-steht-online)
- [Ausgabe 1/2026, Seite 8](https://filemaker-magazin.de/neuigkeit/4312-Die-neue-Ausgabe-FMM_202601-steht-online)
- [Ausgabe 1/2026, Seite 10 bis 11](https://filemaker-magazin.de/neuigkeit/4312-Die-neue-Ausgabe-FMM_202601-steht-online)
- [Ausgabe 2/2025, Seite 23](https://filemaker-magazin.de/neuigkeit/4286-Appetithappen-FMM_202502)
- [Ausgabe 1/2025, Seite 25](https://filemaker-magazin.de/neuigkeit/4282-Appetithappen-FMM_202501)
- [Ausgabe 6/2024, Seite 37](https://filemaker-magazin.de/neuigkeit/4277-Appetithappen-FMM_202406)
- [Ausgabe 1/2023, Seite 30](https://filemaker-magazin.de/neuigkeit/4218-Appetithappen-FMM_202301)
- [Ausgabe 5/2022, Seite 26 bis 27](https://filemaker-magazin.de/neuigkeit/4196-Appetithappen-FMM_202205)
- [Ausgabe 2/2022, Seite 29](https://filemaker-magazin.de/neuigkeit/4174-Appetithappen-FMM_202202)

### Example Databases

- [CURL/SFTP/CURL sFTP Upload File](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/CURL/SFTP/CURL%20sFTP%20Upload%20File.shtml#6ScriptAnchor_)
- [DynaPDF/Create Text as PDFA](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/DynaPDF/Create%20Text%20as%20PDFA.shtml#2ScriptAnchor_)
- [DynaPDF/Report](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/DynaPDF/Report.shtml#1ScriptAnchor_)
- [DynaPDF/Tables](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/DynaPDF/Tables.shtml#5ScriptAnchor_)
- [Registration/Debugging and Registration](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/Registration/Debugging%20and%20Registration.shtml#4ScriptAnchor_)
- [SmartCard/Belgian EID Reader](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/SmartCard/Belgian%20EID%20Reader.shtml#13ScriptAnchor_)
- [Utility functions/FileMaker Custom Functions](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/Utility%20functions/FileMaker%20Custom%20Functions.shtml#2ScriptAnchor_)
- [Utility functions/Install Plugin Update if needed](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/Utility%20functions/Install%20Plugin%20Update%20if%20needed.shtml#1ScriptAnchor_)
- [Utility functions/MBS Plugin Install](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/Utility%20functions/MBS%20Plugin%20Install.shtml#1ScriptAnchor_)
- [Utility functions/Trigger Script on Plugin Error](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/Utility%20functions/Trigger%20Script%20on%20Plugin%20Error.shtml#1ScriptAnchor_)

[HTML Version](component_Plugin.shtml)