AddSubCondition

<< Click to Display Table of Contents >>

 

AddSubCondition

AddSubCondition([Name], [Caption], [Message], [Kind], [AckRequired], [Severity], [Value])

Adds a Subcondition object to the collection of Subconditions. This method has the optional parameters described on the next table.

Parameters of the AddSubCondition method

Parameter

Description

Name

Object's name. Corresponds to Subcondition's Name property. If omitted, the Subcondition is then created as "Subcondition". If the value passed on this parameter already exists in the collection, it is automatically incremented. Please check the general Name property for more information about the allowed characters on the names of objects

Caption

Object's description. Corresponds to Subcondition's Caption property. If omitted, Subcondition's description is an empty String

Message

Subcondition's message text. Corresponds to Subcondition's Message property. If omitted, Subcondition's message is an empty String

Kind

The type of behavior of this Subcondition. Possible values for this parameter are 0: Alarm, 1: Event, or 2: Return. Corresponds to Subcondition's Kind property. If omitted, Subcondition's behavior is 0 (zero, Alarm)

AckRequired

Indicates whether this Subcondition requires acknowledgment. Corresponds to Subcondition's AckRequired property. If omitted, Subcondition requires acknowledgment

Severity

The type of severity of this Subcondition. Possible values for this parameter are 0: High, 1: Medium, or 2: Low. Corresponds to Subcondition's Severity property. If omitted, Subcondition's severity is 1 (one, Medium)

Value

Parameter containing a value that is evaluated to determine whether this alarm occurs or not. Corresponds to the Value property, common to all Alarm Sources. If omitted, Subcondition's value is Null

Was this page useful?