HealthCtrlAlarmOn Function

Returns the status of the parts consumption alarm for the specified Controller parts.

Syntax
HealthCtrlAlarmOn(partType)

Parameters

partType

Specify the part that returns the alarm status as an integer value (1) or a constant as shown below.

Constant	Value	Mode
HEALTH_CONTROLLER_TYPE_BATTERY	1	Specifies the batteries.

Return Values
True if the parts consumption alarm is occurring for the specified parts, otherwise False.

The parts consumption alarm occurs when the parts consumption rate obtained by HealthRateCtrlInfo exceeds 100%.

See Also
HealthCtrlInfo, HealthRateCtrlInfo

HealthCtrlAlarmOn Function Example
The example below determines if the parts consumption alarm is occurring for the Controller batteries.

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