Returns the information for the selected alarm in the Alarm Summary object. Note that even if a column is not displayed, all information is still returned. This function is similar to GetSelectedRow except it includes four additional parameters at the end of its request: Shelvable, ShelveRemDuration, and two Reserved parameters.
Syntax
object.GetSelectedRowAlarmInfo bAcknowledged, Handle, Area, DateIn, DateLast, TimeIn, TimeLast, Node, TagName, Priority, Status, Description, Value, ExtField1, ExtField2, UserDefField1, UserDefField2, Shelvable, ShelveRemDuration, Reserved1, Reserved2
Properties
The GetSelectedRowAlarmInfo method syntax has these parts:
|
Part |
Description |
|
object |
An object expression that evaluates to an object in the Applies To list. |
|
bAcknowledged |
Boolean. Returns True if the alarm has been acknowledged, False otherwise. |
|
Handle |
String. Returns the unique identifier for the alarm. Specifically <type><ipn><nodename>. |
|
Area |
String. Returns the alarm area(s) for the alarm. |
|
DateIn |
String. Returns the date when the block first generated the alarm. |
|
DateLast |
String. Returns the date when the block last generated the alarm. |
|
TimeIn |
String. Returns the time when the block first generated the alarm. |
|
TimeLast |
String. Returns the time when the block last generated the alarm. |
|
Node |
String. Returns the name of the Scada server that generated the alarm. |
|
TagName |
String. Returns the tagname for the alarm. |
|
Priority |
String. Returns the priority for the alarm. |
|
Status |
String. Returns the latched alarm for the block that is in alarm. |
|
Description |
String. Returns the description field for the block in alarm. |
|
Value |
String. Returns the current value of the block in alarm. |
|
ExtField1 |
String. Returns the first extension field for the block in alarm. |
|
ExtField2 |
String. Returns the second extension field for the block in alarm. |
|
UserDefField1 |
String. Returns the current value of the first "A_" field configured for this column. |
|
UserDefField2 |
String. Returns the current value of the second "A_" field configured for this column. |
| Shelvable | String. |
| ShelveRemTime | String. |
| Reserved1 | Not available for use. Reserved. |
| Reserved2 | Not available for use. Reserved. |
Return Value
Boolean. True if an alarm is selected, False if no alarm is selected.
Remarks
If no alarm is selected, all parameters are set to EMPTY.
