Register (Alarm Manager)

Description: Inform the Alarm Manager that a module instance may wish to generate alarms in the future.

 

Format:        Register(AlarmObject[, Enable]);

 

Parameters: AlarmObject is the object value of the new alarm to add to the configured alarm list. A variable called "Name" must exist within the scope of AlarmObject. This variable uniquely defines the text name of the alarm.

          Enable is set to true if alarm should start enabled. If invalid or not defined, the default is enabled.

 

Comments:   The Register subroutine always returns "0".

          Registering an alarm does not trigger an alarm; it merely informs the Alarm Manager that the AlarmObject module instance may wish to generate alarms in the future.