AlarmGetDelayRec

Gets the delay setting for an alarm via the alarm record number.

This is a blocking function. If the function is called from a foreground task that is unable to block, the return value will be -1 and a hardware alarm set.

Syntax

LONG AlarmGetDelayRec(LONG Record, INT Type [, STRING ClusterName] )

Record:

The alarm record number, returned from any of the following alarm functions:

• AlarmFirstCatRec() or AlarmNextCatRec() - used to search for a record by alarm category, area, and type (acknowledged, disabled, etc.).
• AlarmFirstPriRec() or AlarmNextPriRec() - used to search for a record by alarm priority, area, and type (acknowledged, disabled, etc.).
• AlarmFirstTagRec() or AlarmNextTagRec() - used to search for a record by alarm tag, name, and description.
• AlarmGetDsp() - used to find the record that is displayed at a specified AN, for either an alarm list or alarm summary entry. Set the sField argument in AlarmGetDsp() to "RecNo".

Type:

The type of delay:

0 - Delay (digital alarm/advancedalarm)

1 - High high delay (analog alarm)

2 - High delay (analog alarm)

3 - Low delay (analog alarm)

4 - Low low delay (analog alarm)

5 - Deviation delay (analog alarm)

ClusterName:

Specifies the name of the cluster in which the Alarm Server resides. This is optional if you have one cluster or are resolving the alarm server via the current cluster context. The argument is enclosed in quotation marks "".

Return Value

The alarm delay if successful, otherwise -1 is returned. Use IsError() to retrieve extended error information.

Related Functions

AlarmNotifyVarChange, AlarmSetDelayRec, AlarmGetDelay

See Also

Alarm Functions

Published June 2018