|
Invokes the specified Alarm server action or the default FireAlarm.
Syntax 1
FireAlarm(
alarmAction,
alarmID,
conditionID
[,commentID]
[,comment]
)
Parameters
alarmAction
|
|
Type:
|
character
|
|
Alarm serverAction name. If #NOTHING# or an empty string is specified, the action name specified in the DefaultFireAlarm route property will be used.
|
alarmID
|
|
Type:
|
character
|
|
Alarm ID. If #NOTHING# or an empty string is specified, the AlarmID specified in the DefaultFireAlarm route property will be used.
|
conditionID
|
|
Type:
|
Number
|
|
Condition ID.
When multiple [ONCONDITION] are specified in the alarm master, specify the numbers from top to bottom starting with 0. If there is one alarm condition, specify 1 (if there is an occurrence and return, occurrence is 1 and return is 0). If #NOTHING# is specified, the ConditionID specified in the DefaultFireAlarm root property will be used.
|
commentID
|
|
Type:
|
Number
|
|
Comment ID. Array can be specified. If comment columns such as [CM0], [CM1] are specified in the alarm master, specify the comment number. If #NOTHING# is specified, the CommentID specified in the DefaultFireAlarm root property will be used.
|
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.
|
Syntax 2
FireAlarm(
comment
)
Parameters
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.
|
 Explanation
Syntax 1 invokes FireAlarm with the specified Alarm server action.
Syntax 2 invokes FireAlarm with the alarmAction, alarmID, conditionID, and commentID specified in the DefaultFireAlarm root property.
|
Supported
reference
FireAlarm (Remote alarm grid client control)
|