AlarmGetDsp

Gets field data from the alarm record that is displayed at the specified AN. You can use this function for Alarm Pages, Sequence of Events pages, and Alarm Summary pages (an Alarm Page, SOE Page, and Alarm Summary needs to be displayed before this function can be used).

You can call this function on an Alarms Server or a client to get the contents of any field in the alarm record at that AN.

You can return the record number of the alarm record for use in other alarm functions, for example, to acknowledge, disable, or enable an alarm (on an Alarms Server).

The AlarmGetDsp() function does not support hardware alarms.

If this function is not called from a foreground task, it becomes a blocking function.

Syntax

STRING AlarmGetDsp(INT AN, STRING Field)

AN:

AN number of an ALMCB Alarm record. Equal to AN where actual ALMCB resides + Offset into the list of ALMCB records.

Field:

The name of the field from which the data is retrieved.

The contents of the following fields can be retrieved when the alarm page is displayed.

ALMCOMMENT, AREA, CATEGORY, CAUSE1..8, CLUSTER, COMMENT, CONSEQUENCE1..8, CUSTOM1..8, DATE, DATEEXT, DEADBAND, DELAY, DEVDELAY, DEVIATION, DESC, DISABLECOMMENT, DISABLEENDDATE, DISABLEENDDATEEXT, DISABLEENDTIME, EQUIPMENT, FONT, FORMAT, HDELAY, HELP, HHDELAY, HIGH, HIGHHIGH, LDELAY, LLDELAY, LOGSTATE, LOW, LOWLOW, NAME, PAGING, PAGINGGROUP, PRIORITY, RATE, RECNO, RESPONSE1..8, RESPONSENUM, STATE, STATE_DESC, TAG, TIME, TYPE, USERLOCATION, VALUE.

The contents of the any of the above fields (except for State) and the following fields can be retrieved when the Alarm Summary is displayed:

ACKDATE, ACKDATEEXT, ACKTIME, DELTATIME, FULLNAME, NATIVE_SUMDESC, NATIVE_COMMENT, OFFDATE, OFFDATEEXT, OFFMILLI, OFFTIME, ONDATE, ONDATEEXT, ONMILLI, ONTIME, SUMSTATE, SUMDESC, USERNAME.

The following fields can be retrieved when the Alarm SOE is displayed:

ALMCOMMENT, AREA, CATEGORY, CLUSTER, COMMENT, CUSTOM1..8, DATE, DATEEXT, DEADBAND, DEVIATION, EQUIPMENT, FULLNAME, HIGH, HIGHHIGH, LOGSTATE, LOW, LOWLOW, MESSAGE, NAME, NATIVE_COMMENT, NATIVE_SUMDESC, PAGING, PAGINGGROUP, PRIORITY, RATE, RECORDID, STATE, STATE_DESC, SUMDESC, SUMSTATE, TAG, TIME, TYPE, USERLOCATION, USERNAME.

See Browse Function Field Reference for more information about these fields.

Return Value

The alarm field data (as a string) or empty string "".

Related Functions

AlarmDsp

Example

! Display the tag and category for the alarm at the specified AN.

FUNCTION

AlarmData(INT AN)

STRING Category;

STRING Tag;

Category=AlarmGetDsp(AN,"Category");

Tag=AlarmGetDsp(AN,"Tag");

Prompt("Alarm "+Tag+" is Category "+Category);

END

See Also

Alarm Functions