(VTScada-Layer function. Must be called with a leading backslash.)
| Description: | Returns an action label for an alarm / event record |
| Returns: | Text |
Usage:  |
Script or Steady State |
| Function Groups: | Alarm |
| Related to: | |
| Format: |
\GetAlarmActionLabel(IsHistory, Record, Action) |
| Parameters: |
| IsHistory |
| Required Boolean. Set TRUE if you want the label for a historical event or FALSE for the current status |
| Record |
| Optional. The alarm record, for which to obtain the action label. |
| Action |
| Optional action code, for use if Record is invalid and IsHistory is true. |
| Comments: |
This function is a user-interface helper module, useful for converting the Action field of an AlarmRecord into a displayable event or status label. Displayed values are those stored in the application properties, AlarmEventDesc0-21 (IsHistory==TRUE) or AlarmStatusDesc0-5(IsHistory==FALSE). |
Example:
If Watch(1);
[
Info = \GetPhrase(\GetAlarmActionLabel(TRUE, Invalid, "Active"));
...
This basic example simply returns the assigned label for "Active" in the current language. (Which in English, is "Active".)
