AlmPriority (Tag-based PE function)

Return the priority of an Alarm State.

Syntax

almPriority(alm)

Arguments

alm

A digital state value from a PI Alarm State Set.

Returns

The priority of the given alarm. Priorities are small positive integers. Priority 0 is an alarm that is never unacknowledged.

Exceptions/Errors

If the argument is not from a valid Digital State Set for alarms, an error condition is returned.

Example

almPriority('alarmtag')

almpriority(digstate("__ Lolo"))

AlmAckStat (page ), AlmCondition (page ), AlmCondText (page )