ASSOCLABEL

Concept Link IconSee also Concept Link IconExample

Changes the configuration of an associated label.

WebVue support - Yes.

Mode Mnemonic Syntax
1 SETLABEL 1
2 SETBITLABEL 1
3 SETALARMLABEL 1

Arguments common to more than one mode

Argument

Meaning

AssocLabelName

Name of the associated label.

EventCode

Code for the type of event.

Label

The new string for the event.

Language

Language number: 0 or 1.

Syntax 1

IntVal = ASSOCLABEL(Mode, AssocLabelName, EventCode, Label [, Language]);

Return type: INTEGER.

Execution

Mode

Mnemonic

Action

1 SETLABEL

Change the label associated with the EventCode.

EventCode can take the following values:

0: State is 0
1: State is 1
2: Change to 0
3: Change to 1
4: Command to 0
5: Command to 1
6: Invalid

2 SETBITLABEL

Change the label associated with the EventCode to set a bit label.

EventCode can take the same values as for the mode SETLABEL.

3 SETALARMLABEL

Change the label associated with the EventCode to set an alarm label.

EventCode can take the following values:

0: Alarm on - not ack
1: Alarm on - ack
2: Alarm off
3: Alarm off - not ack
4: Alarm unavailable
5: Alarm acknowledgment
6: Command to 0
7: Command to 1
8: Alarm inhibited
9: Alarm not accessible
10: Alarm user masked
11: Alarm program masked
12: Alarm variable masked
13: Alarm expression masked

    Return: 1 if successful, else 0 (wrong EventCode, referenced associated labels not found).

Example

For an example, select the Example link above.