(VTScada-Layer function. Must be called with a leading backslash.)
| Description: | Returns text in the specified language for a given phrase identifier key or ParmPhrase structure. |
| Returns: | Text |
Usage:  |
Script or Steady State |
| Function Groups: |
String and Buffer |
| Related to: | GetPhrase | GetParmPhrase | GetDatePhrase | GetTimePhrase | GetRawPhrase | |
| Format: |
\GetPhraseForLang(PhraseID, Language[, LMHolder]) |
| Parameters: |
| PhraseKey |
| Required. The identifying key for a phrase. May be either a string ID that uniquely identifies given text or a ParmPhrase structure, which consists of a PhraseKey and up to 10 parameters. |
| Language |
| Required text. Name of the language for which the phrase is to be found. |
| LMHolder |
| Optional. An instance of the user session where the current language is set. Defaults to the system’s root object. Useful only when a very large number of \GetPhraseForLang calls are issued consecutively. |
| Comments: |
For most purposes, \GetPhrase is preferred over \GetPhraseForLang, since \GetPhrase will use the currently logged-on user's selected language (or default to English). |
Example:
\GetPhraseForLang("CloseLabel", ErrorLang)
returns the text for the file close label, in the language (assigned elsewhere) for error messages.
