TranslationLoad
This function loads an external translation file and either replaces or appends to the current translation.
| Function | Group | Execution | Windows | Embedded | Thin Client | Mobile Access |
|---|---|---|---|---|---|---|
| TranslationLoad | Translation | Synchronous | Supported | Supported | Not supported | Not supported |
Syntax
TranslationLoad( strFileName, numAppend )
- strFileName
- The file path and name of the translation file (*.TRA or *.CSV) to be loaded. If you specify a relative path, the function will look first in the project folder and then in the Web sub-folder. If you are running your application on the Web, you must place the file in the Web sub-folder and specify a relative path.
- numAppend
- A numeric flag that indicates whether the loaded translation file replaces or appends to the existing contents of the Translation Table. Specify one of the following values:
Value Description 0 Completely replace the contents Translation Table and replace with the contents of the loaded translation file. 1 Keep the contents of the Translation Table, and then append the contents of the loaded translation file only if they are not already present. 2 Keep the contents of the Translation Table, and then append the contents of the loaded translation file, replacing any duplicates. 3 Reset the Translation Table to its initial contents when the project was run. If this value is specified, strFileName is ignored.
Returned value
This function returns one of the following possible values:
| Value | Description |
|---|---|
| -3 | Failed to load the translation file. The file format is invalid or you do not have the necessary privileges. |
| -2 | The specified file cannot be found. |
| -1 | Invalid parameters. |
| 0 | Function executed successfully. |
Examples
TranslationLoad( "alternate.tra", 0 )
TranslationLoad( "Webpt-BR.csv", 1 )
TranslationLoad( "", 3 )