 |
Serial_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
Serial_Version ( switches )
Parameters
| switches | determines 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) |
| -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 |
| -GetPluginInstallPath | returns the path where the plug-in is installed |
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:
-GetVersionString:
If you asked for the version string it will return for example “Serial Plug-in 6.0”
-GetVersionNumber:
If you asked for the version number it returns the version number of the plug-in x1000. For example version 6.0 will return number 6000.
-ShowFlashDialog:
This will show the flash dialog and then return the error code 0.
Originated in
Troi Serial Plug-in 3.0
Compatibility
FileMaker Pro 16 to 19
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 a question mark from any external function that is not loaded.
Example
Serial_Version ( "" )will for example return “Serial Plug-in 6.0”
Example 2
Serial_Version ( "-GetVersionNumber" )will return 6000 for version 6.0
Serial_Version ( "-GetVersionNumber" )will return 6510 for a possible future version 6.5.1
So for example to use a feature introduced with version 5.0 test if the result is equal or greater than 5000.
Related function
| Serial_VersionAutoUpdate |
Related topics
Troi Serial Plug-in online help (overview)
