GetEventField
- Last UpdatedAug 04, 2025
- 2 minute read
Retrieves the value of the field identified by the key in the current record.
This function assumes a previous call to GetNextEvent (to set the current record), otherwise it will return an empty string.
Syntax
GetEventField(Alarm key, Error ID, Network Num, ON Time, OFF Time, Ack Time, Status, Area, Fbcomment, FBInstanceName + FBPinName)
-
Alarm key
The key used to identify the alarm this event belongs to. This key is generated internally using instance name, pin name, and comment
-
Error ID
Error ID generated by the PLC, used for acknowledgement
-
Network Num
Allow to retrieve the PLC (DEVICE) that emits this record
-
ON Time
Time of the occurrence of the event in the PLC (UTC seconds timestamp)
-
OFF Time
Time of disappearance of event in the PLC (UTC seconds timestamp)
-
Ack Time
Time of acknowledgement of the event in the PLC (UTC seconds timestamp)
-
Status
Current status of the event. The status value can be interpreted as:
Bit
Title
0
1
0
Status
Disappeared
Active
1
Acknowledgment
Not acknowledged or acknowledgment not requested
Acknowledged
2
Need Acknowledge
Acknowledgment is not required
Acknowledgment is required
3
Deleted
Not removed
Removed
4
New
Existing alarm
New alarm
5
Auto dereg
no
Detected error has been simultaneously activated and deactivated
-
Area
Area as defined in the PLC diagnostic buffer. This may or may not match the definition of area in Plant SCADA.
-
Fbcomment
Comment associated with the instance of the FB for this anomaly
-
FBInstanceName + FBPinName
Name of the instance of the FB that caused this anomaly + the pin name
Return value
String value of the field.