FireAlarm

<< Click to Display Table of Contents >>

マニュアル > コントロールリファレンス > ルート > ルートメソッド >

FireAlarm


 

指定したアラームサーバアクションまたはデフォルトのFireAlarmを呼び出す。

 


構文1

FireAlarm(

         alarmAction,

         alarmID,

         conditionID

         [,commentID]

         [,comment]

         )

 


パラメータ

 

alarmAction


型:

文字


アラームサーバアクション名。#NOTHING#もしくは空文字を指定した場合、DefaultFireAlarmルートプロパティで指定したアクション名が使用される。

 

alarmID


型:

文字


アラームID。#NOTHING#もしくは 空文字を指定した場合、DefaultFireAlarmルートプロパティで指定したAlarmIDが使用される。

 

conditionID


型:

数値


コンディションID。

アラームマスターで複数の[ONCONDITION]を指定した時に、上から順に0から始まる数値を指定する。アラーム条件が1つの場合、1を指定する(発生復帰がある場合、発生が1で、復帰が0)。#NOTHING#を指定した場合、DefaultFireAlarmルートプロパティで指定したConditionIDが使用される。

 

commentID


型:

数値


コメントID。配列指定可。アラームマスターで[CM0]、[CM1]などのコメント列を指定した場合、そのコメントの番号を指定する。#NOTHING#を指定した場合、DefaultFireAlarmルートプロパティで指定したCommentIDが使用される。

 

comment


型:

文字


コメント。配列指定可。commentIDで指定したコメント列に対する実際のコメントを指定する。

 

戻り値



型:

ブール


FALSE - 失敗。TRUE - 成功。

 


構文2

FireAlarm(

         comment

         )

 


パラメータ

 

comment


型:

文字


コメント。配列指定可。commentIDで指定したコメント列に対する実際のコメントを指定する。

 

戻り値



型:

ブール


FALSE - 失敗。TRUE - 成功。

 

 


hmtoggle_plus1 解説

 


サポート対象


×

スクリプトアクション

ブラウザスクリプト

×

演算式構文

 


参照