almQuery() Function

Performs a query to update a named Distributed Alarm Display object and uses the specified parameters.

Category

Alarms

Syntax

[Result=]almQuery(ObjectName,AlarmList,FromPri,ToPri,State,Type);

Arguments

ObjectName

The name of the alarm object. For example, AlmObj_1.

AlarmList

Sets the Alarm Query/Name Manager alias to perform the query against, for example, "\intouch!$System" or a Message tag.

FromPri

Starting priority of alarms to show. For example, 100 or integer tag.

ToPri

Ending priority of alarms to show. For example, 900 or integer tag.

State

Specifies type of alarms to show. For example, "UnAck" or Message tag. Valid states are All, UnAck or Ack.

Type

The type of alarm records that appear in the updated display:

"Hist" = Historical alarms

"Summ" = Summary alarms

Example

This statement retrieves all historical alarms specified in MyAlarmListGroup with a priority of 500 to 600. The alarms appear in the AlmObj_1 alarm display.

almQuery("AlmObj_1","MyAlarmListGroup",500,600,"All","Hist");

In this example, MyAlarmListGroup is an alarm list configured from the Name Manager setup.

See Also

almDefQuery(), almSetQueryByName()