(VTScada-Layer function. Must be called with a leading backslash.)
| Description: | Returns parameterized 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: | GetParmPhrase | GetDatePhrase | GetTimePhrase |
| Format: |
\GetParmPhraseForLang(PhraseKey, Language[, P0, P1, P2, P3, P4, P5, P6, P7, P8, P9]) |
| 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 PhraseID and up to 10 parameters. |
| Language |
| Required text. Name of the language for which the phrase is to be found. For example "EN" for English. |
| P0 through P9 |
| Any text that will be substituted into placeholders in the phrase matching the index of the parameter. (%0 through %9) |
| Comments: |
For most purposes, \GetParmPhrase is preferred over \GetParmPhraseForLang, since \GetParmPhrase will use the currently logged-on user's selected language (or default to English). |
Example:
\GetParmPhraseForLang("FileMessageID", \ErrorLang, PickValid(SomeFileName, "")
returns the text for a hypothetical file message label using the language (assigned elsewhere) for error messages, and including the name of a file to which the message applies.
