GetPhraseID

(Function Library)

Description:	Returns the key matching a given phrase.
Returns:	Text
Usage:	Script or steady state.
Function Groups:	String
Related to:	GetPhrase | GetPhraseForLang | GetParmPhrase
Format:	\FunctionLib.GetPhraseID(Phrase[, Language, Index])
Parameters:

Phrase

Text, for which you want to retrieve the key.

Language

Optional Text. The two-letter code specifying the language in which to look for the phrase. Defaults to the user's currently selected language.

Index

Optional Numeric. Some words may be present several times, each with a different meaning. (For example, "right" might be the opposite of "left", it might indicate that something is correct, or it may refer to an entitlement.)

Comments:

This module is a member of the Function Library, and must therefore be prefaced by \FunctionLib as shown in the "Format" section. Searches only the application's language files, not those belonging to VTScada.

Example:

  \FunctionLib.GetPhraseID("Test description")

Will return the phrase key for "Test description", assuming that some tag was given that as a description.