 |
TrText_Version |
Use this function to see which version of the plug-in is loaded.
Note: This function is also used to register the plug-in.
Syntax
TrText_Version ( switches )
Parameters
| switches | determine the behaviour of the function |
Switches
switches can be one of this:
| -GetVersionString | the version string is returned (default) |
| -GetVersionNumber | returns the version number of the plug-in |
| -ShowFlashDialog | shows the Flash Dialog of the plug-in (returns 0) |
| -GetPluginInstallPath | returns the path where the plug-in is installed |
| -GetRegistrationState | get the registration state of the plug-in: 0 = not registered ; 1 = registered |
| -UnregisterPlugin | sets the registration state of the plug-in to unregistered |
| -GetStartupRegistrationLog | returns a text log of the plug-in’s registration process at startup time of FileMaker |
If you leave the parameter empty the version string is returned.
Returned Result
Data type returned
Text
Result
The function returns ? if this plug-in is not loaded. If the plug-in is loaded the result depends on the input parameter. It is either a:
VersionString:
If you asked for the version string it will return for example “Troi Text Plug-in 6.0”
VersionNumber:
If you asked for the version number it returns the version number of the plug-in x1000. For example version 5.7.1 will return number 5710.
ShowFlashDialogResult:
This will show the flash dialog and then return the error code 0.
GetRegistrationState: returns 0 = the plug-in is not registered ; 1 = the plug-in is registered.
GetStartupRegistrationLog: returns a text log of the plug-in’s registration process at startup time of FileMaker.
Originated in
Troi Text Plug-in 1.2
Compatibility
FileMaker Pro 17 to FileMaker Pro 21 (2024)
Considerations
IMPORTANT Always use this function to determine if the plug-in is loaded. If the plug-in is not loaded use of external functions may result in data loss, as FileMaker will return an empty field to any external function that is not loaded.
Example
TrText_Versionwill return “Troi Text Plug-in 6.0”.
Example 2
TrText_Version ( "-GetVersionNumber" )will return 4100 for version 4.1.
TrText_Version ( "-GetVersionNumber" )will return 2701 for version 2.7b1
TrText_Version ( "-GetVersionNumber" )will return 2730 for version 2.7.3
To use a feature introduced with version 4.1 test if the result is bigger than 4100.
Related function
| TrText_VersionAutoUpdate |
Related topics
Troi Text Plug-in online help (overview)