HealthCtrlAlarmOn関数

コントローラーに関する指定した種別の部品の部品消耗アラーム状態を返す関数です。

書式
HealthCtrlAlarmOn(部品種別)

パラメーター

部品種別

アラーム状態を返す部品を整数値 (1)、または以下に示す定数で指定します。

定数	値	モード
HEALTH_CONTROLLER_TYPE_BATTERY	1	バッテリーを指定します。

戻り値
指定した部品が部品消耗アラームを発生している場合はTrue、発生していない場合はFalseを返します。

部品消耗アラームは、HealthRateCtrlInfoで取得される部品消耗率が100%を超えた場合に発生します。

参照
HealthCtrlInfo, HealthRateCtrlInfo

HealthCtrlAlarmOn関数使用例
コントローラーのバッテリー部品消耗アラームが発生しているかを判断する例です。

Function PrintAlarm
  If HealthCtrlAlarmOn(HEALTH_CONTROLLER_TYPE_BATTERY) = True Then
    Print "Controller Battery NG"
  Else
    Print "Controller Battery OK"
  EndIf
Fend