| |
| META TOPICPARENT |
name="APPXRuntimeSubroutineAPI" |
.CONVERT TRANSLATE |
|
<
< | This subroutine converts a string from one language to another. |
>
> | This subroutine converts a string from one language to another using the Application and System Dictionaries. |
| |
Usage: |
| |
Description: |
|
<
< | This subroutine converts a string from one language to another. The first five parameters are required, if any are missing the subroutine will CANCEL. The <trans_type>, <trans_app_id> and <trans_ver_id> parameters are optional. The translation uses the Dictionaries and Translations you have entered in the applications. Note that this routine should be invoked via SUBR with a RELATED or DETACHED invocation to ensure none of your fields are changed. |
>
> | This subroutine converts a string from one language to another using the Application and System Dictionaries. The first five parameters are required, if any are missing the subroutine will CANCEL. The <trans_type>, <trans_app_id> and <trans_ver_id> parameters are optional. The translation uses the Dictionaries and Translations you have entered in the applications. Note that this routine should be invoked via SUBR with a RELATED or DETACHED invocation to ensure none of your fields are changed. |
| |
<trans_text> returns the translated version of <source_text> (Required). This must be PASSed with Share "Y" to return the value. |
| | Token, Message and Field all follow the same rules for translating, i.e., they look for an exact match. If a match is not found, the text will be added to the Application Dictionary under the specified <trans_type>.
|
|
<
< | <trans_app_id> is the Application Id whose dictionaries should be used for the translation (Optional). Defaults to the current application if not PASSed, or is blank. |
>
> | <trans_app_id> is the Application Id whose dictionaries should be used for the translation (Possibly optional, see NOTE below). Defaults to the current application if not PASSed, or is blank. |
| | |
|
<
< | <trans_ver_id> is the Version Id whose dictionaries should be used for the translation (Optional). Defaults to the current version if not PASSed, or is blank. |
>
> | <trans_ver_id> is the Version Id whose dictionaries should be used for the translation (Possibly optional, see NOTE below). Defaults to the current version if not PASSed, or is blank. |
| |
<field_name> (Version 6.0 & higher only) is only required for Token translation types. It is the name of Token field you are translating. This is only available in Release 6.0 & higher. Prior to release 6.0 it is not possible to use this API to translate a Token field. |
|
<
< | If <trans_text> is too small to contain the translated text, --- .CONVERT TRANSLATE will contain 'Data was truncated'. |
>
> | If <trans_text> is too small to contain the translated text, --- .CONVERT TRANSLATE will contain 'Data was truncated'. |
| |
In all cases, if a translation is not found in the Application Dictionary, then the System Dictionary will be checked. If a translation is still not found, the text will be added to the Application Dictionary.
Note that this routine will return the <source_text> in the <trans_text> field if it is unable to translate <source_text>. In other words, you will always get something back from this routine, either the translated text, or as best a translation as possible. This is especially true if you are using the 'Text' <trans_type>. The translation routine always starts with the largest block of text and works it's way down until it has attempted everything. If it can find a match for the entire block of text, it will return that. If not, it will then look for matches of the paragraphs in the text. If it can find a match for the paragraph, it will return that. If not, it will look for matches at the sentence level. If it still cannot find a match, it will attempt to translate individual words, depending on the "Translate Words" setting on the <from_lang> file. Thus the result returned could be a mix of the original text and the portions that were able to be translated. |
|
>
> |
NOTE: If you invoke this via a SUBR command, the <trans_app_id> and <trans_ver_id> are NOT optional and must be PASSed for the correct dictionaries to be referenced. If you invoke this via a GOSUB, then <trans_app_id> and <trans_ver_id> are optional, however, --- TEMP 2k and some numeric PDFs (--- AI, etc) are not preserved by the subroutine and will change. |
| | Comments:
Read what other users have said about this page or add your own comments. |
Copyright © 2008-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.