FireAlarm

<< Click to Display Table of Contents >>

Manual > Control Reference > Data > Remote alarm grid client control > Method >

FireAlarm

 

Manually raise an alarm.

 

syntax

FireAlarm(

         alarmID,

         conditionID,

         commentID,

         comment

         )

 

Parameters

 

alarmID

Type:

character

The alarm ID.

 

conditionID

Type:

Number

Condition ID.

When multiple [ONCONDITION] are specified in the alarm master, specify the numbers starting from 0 from the top. If there is one alarm condition, specify 1. (If there is an occurrence and return, occurrence is 1 and return is 0.)

 

commentID

Type:

Number

Comment ID. Array can be specified. If a comment string such as [CM0], [CM1] is specified in the alarm master, specify the comment number.

 

comment

Type:

character

Comment. Array can be specified. Specify the actual comment for the comment column specified by commentID.

 

Return Value

Type:

Boolean

FALSE - Failure. TRUE - Success.

 

hmtoggle_plus1Explanation

This is used to manually generate an alarm. It is used to obtain operation history such as when a button is pressed.

 

For example, if you want to save the operation history from the screen, add a line to the alarm master, specify any ID (characters are allowed) in [AlarmID], and set [RECOVER] and [ACK] to n. The following is an example.

 

Alarm Master Example)

[AlarmID], [RECOVER], [ACK], [ONCONDITION], [CM0], [CM1]

USER, n, n, , ,

...

* [ONCONDITION], [CM0], [CM1] are left blank

 

Method call example)

xxx.FireAlarm("USER", 1, c(0, 1), c("UserA", "Value updated."));

 

 

 

reference

 

SubscribeSummary

SubscribeHistorical

SubscribeRealtime

CancelSubscribe

Ack

AckSelected

AckPage

AckAll

IsCanAck

FireAlarm

FireAlarm (Root)

GetAlarmScriptResult

GetAlarmLayout

Connect

DisConnect

GetLastError