<< Click to Display Table of Contents >>
マニュアル > コントロールリファレンス > データ > リモートアラームグリッドコントロール > メソッド >
アラームを手動で発生させる。
構文
FireAlarm(
alarmID,
conditionID,
commentID,
comment
)
パラメータ
alarmID
型:
文字
アラームID。
conditionID
数値
コンディションID。
アラームマスターで複数の[ONCONDITION]を指定した時に、上から順に0から始まる数値を指定する。アラーム条件が1つの場合、1を指定する。(発生復帰がある場合、発生が1で、復帰が0。)
commentID
コメントID。配列指定可。アラームマスターで[CM0]、[CM1]などのコメント列を指定した場合、そのコメントの番号を指定する。
コメント。配列指定可。commentIDで指定したコメント列に対する実際のコメントを指定する。
戻り値
ブール
FALSE - 失敗。TRUE - 成功。
解説
アラームを手動で発生させます。ボタンが押されたなど、操作の履歴などを取得する際等に使用されます。
例えば画面からの操作履歴を保存したい場合、アラームマスターに1行追加し[AlarmID]に自由なID(文字可)を指定し、[RECOVER]、[ACK]をnとします。以下が例になります。
アラームマスター例)
[AlarmID], [RECOVER], [ACK], [ONCONDITION], [CM0], [CM1]
USER, n, n, , ,
...
※[ONCONDITION], [CM0], [CM1]は何も指定しない
メソッド呼び出し例)
xxx.FireAlarm("USER", 1, c(0, 1), c("ユーザーA", "値を更新しました。"));
参照
SubscribeSummary
SubscribeHistorical
SubscribeRealtime
CancelSubscribe
Ack
AckSelected
AckPage
AckAll
IsCanAck
FireAlarm
FireAlarm(ルート)
GetAlarmScriptResult
GetAlarmLayout
Connect
DisConnect
GetLastError