Skip to main content
Version: v4 (Stable)

ENUMPROCESSEDALARMS

ENUMPROCESSEDALARMS(nAlarmId AS INTEGER, nProcessed AS INTEGER[, sTagIdent AS STRING[, sDataServerIdent AS STRING[, sFilterName AS STRING]]]) AS BOOLEAN

Enumerates the alarms processed by the prior call of the PROCESSEVENT function.

The identifier code of the alarm processed by the filter whose name is returned in the optional parameter <sFilterName> (tag created, alarm set, reset or acknowledged) is returned in <nAlarmId>.

The performed treatment is indicated by the bit mask returned in <nProcessed>:

  • Bit0 (0x01): indicates that the alarm tag has been created
  • Bit1 (0x02): indicates that the alarm has been reset
  • Bit2 (0x04): indicates that the alarm has been set
  • Bit3 (0x08): indicates that the alarm has been acknowledged

The optional parameter <sTagIdent> returns the alphanumeric identifier of the processed tag. The optional parameter <sDataServerIdent> returns the alphanumeric identifier of the data server containing the tag.

At the first call after PROCESSEVENT, the function retrieves the first processed alarm and returns TRUE (if at least one alarm has been processed, FALSE otherwise). Each subsequent call of the function returns the next alarm until the processed alarms are exhausted (return FALSE).