TrText_Version (function reference)

By November 1, 2017November 13th, 2017Online Help, Troi Text Plug-in
Troi Text Plug-in for FileMaker Pro

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.

SyntaxFunction badge

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

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 4.5”

VersionNumber:
If you asked for the version number it returns the version number of the plug-in x1000. For example version 2.7.1 will return number 2710.

ShowFlashDialogResult:
This will show the flash dialog and then return the error code 0.

Originated in

Troi Text Plug-in 1.2

Compatibility

FileMaker Pro 12 to 16

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_Version

will return “Troi Text Plug-in 4.5”.

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 functionFunction badge

TrText_VersionAutoUpdate

Related topics

Troi Text Plug-in online help (overview)


Online Help Page for Troi Text Plug-in for 12 to 16 –> TrText_Version (textp9001) 2017-1112 17:29:10