Dial_Version |
Use this function to see which version of the plug-in is loaded. This function is also used to register the plug-in.
Syntax
Dial_Version ( switches )
Parameters
switches | determine the behavior 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, returns 0 |
-GetStartupRegistrationLog | returns a text log of the plug-in’s registration process at startup time of FileMaker |
If you leave the switches 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 switches parameter. It is either a:
-GetVersionString:
If you asked for the version string it will return for example “Troi Dialog Plug-in 11.0”.
-GetVersionNumber:
If you asked for the version number it returns the version number of the plug-in x1000. For example version 7.5.1 will return number 7510.
-ShowFlashDialog:
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.
Originated in
Troi Dialog Plug-in 1.2
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 an empty field to any external function that is not loaded.
version 11 added the switch “-GetStartupRegistrationLog”. This will return a text log of the plug-in’s registration process at startup time of FileMaker Pro. When you have problems registering the plug-in, you can see if the payment certificate was found and if a valid registration code was found.
Example
Set Variable [ $Result; Dial_Version ( "" ) ]
will for example return “Troi Dialog Plug-in 11.0”.
Example 2
Dial_Version ( "-GetVersionNumber" )
will return 7510 for version 7.5.1
Dial_Version ( "-GetVersionNumber" )
will return 5501 for version 5.5b1
Dial_Version ( "-GetVersionNumber" )
will return 11000 for version 11.0
So for example to use a feature introduced with version 7.5 test if the result is equal to or greater than 7500.
Used in example file
Version.fmp12
Related function
Dial_VersionAutoUpdate |
Related topics
Troi Dialog Plug-in online help (overview)