| Description: | Returns text in the currently selected 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 | GetPhraseForLang |GetRawPhrase | GetPhraseID |
| Format: |
\GetPhrase(PhraseKey) |
| Parameters: |
| PhraseKey |
|
Required. The identifying key for a phrase. May be either a string that uniquely identifies given text or a ParmPhrase structure, which consists of a PhraseKey and up to 10 parameters. |
| Comments: |
If the input is a ParmPhrase, \GetPhrase will recursively translate the phrase. In the input is just text (not a phrase key) then it will be passed back unchanged. \GetPhrase("Hello World") returns "Hello World".
If working with parameterized phrases, \GetParmPhrase may be preferred in order to avoid the effort of assembling a ParmPhrase structure, which can be built only in Script.
The Language property in the caller's scope is used to specify the language name (e.g. en). Defaults to the Windows system's language. |
Example:
\GetPhrase("OKLabel")
returns "OK", assuming that the current language is English.
