5.8.9 Suppress2 Method
The Suppress2 Method extends the Suppress Method, by adding an optional Comment. For other functionality see the Suppress Method definition.
Signature
Suppress2(
[in] LocalizedText Comment
);The parameters are defined in Table 53| Argument | Description |
| Comment | A localized text that shall be applied to the Condition. |
If the Comment argument is NULL (both locale and text are empty) it shall be ignored and any existing comments will remain unchanged. To reset the comment an empty text with a locale shall be provided.
Method Result Codes in Table 51 (defined in Call Service)
| Result Code | Description |
| Bad_MethodInvalid | The MethodId provided does not correspond to the ObjectId provided. See 10000-4 for the general description of this result code. |
| Bad_NodeIdInvalid | Used to indicate that the specified ObjectId is not valid or that the Method was called on the AlarmConditionType Node. See 10000-4 for the general description of this result code. |
| Bad_InvalidArgument | The Comment string provided exceeds the allowed length for the comment or is invalid in some other manner. |
Table 55 specifies the AddressSpace representation for the Suppress2 Method.
| Attribute | Value | ||||
| BrowseName | Suppress2 | ||||
| References | NodeClass | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| HasProperty | Variable | InputArguments | Argument[] | PropertyType | Mandatory |
| AlwaysGeneratesEvent | ObjectType | AuditConditionSuppressionEventType | Defined in 5.10.4 | ||
| ConformanceUnits | |||||
|---|---|---|---|---|---|
| A & C Suppression2 by Operator |
If Auditing is supported, this Method shall generate an Event of AuditConditionSuppressionEventType for all invocations of the Method.