The RemoveFromService2 Method extends the RemoveFromService Method, by adding an optional Comment. For other functionality see the RemoveFromService Method definition.
Signature
RemoveFromService2(
[in] LocalizedTextComment
);
The parameters are defined in Table 63
Table 63 – RemoveFromService2 Method parameters
|
Argument |
Description |
|
Comment |
A localized text to be applied to the Condition. |
If the Comment argument is NULL (both locale and text are empty) it will be ignored and any existing comments will remain unchanged. If the comment is to be reset, an empty text with a locale shall be provided.
Method result codes in Table 64 (defined in Call Service)
Table 64 – RemoveFromService2 result codes
|
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. |
Comments
Instances that do not expose the OutOfService State shall reject RemoveFromService2 calls. RemoveFromService2 Method applies to an Alarm instance, even if it is not currently in the Active State.
Table 65 specifies the AddressSpace representation for the RemoveFromService2 Method.
Table 65 – RemoveFromService2 Method AddressSpace definition
|
Attribute |
Value |
||||
|
BrowseName |
RemoveFromService2 |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
HasProperty |
InputArguments |
Argument[] |
PropertyType |
Mandatory |
|
|
AlwaysGeneratesEvent |
ObjectType |
AuditConditionOutOfServiceEventType |
Defined in 5.10.12 |
||
|
ConformanceUnits |
|||||
|
A & C OutOfService2 |
|||||
If Auditing is supported, this Method shall generate an Event of AuditConditionOutOfServiceEventType for all invocations of the Method.