The DeleteAliasesFromCategory Method allows a Client to remove AliasNames from the AliasNameCategory. The signature of this Method is specified below; the arguments are defined in Table 13.
This Method shall only delete AliasName instances that are defined on the Server exposing this Method. I.e. an aggregating Server that has pulled AliasName instances from an aggregated Server cannot delete AliasName instances that are from the aggregated Server.
Signature
DeleteAliasesFromCategory
(
[in] String[] AliasNames,
[in] ExpandedNodeId []TargetNodes,
[out] StatusCode[]ErrorCodes
);
Table 13 – DeleteAliasesFromCategory Method Arguments
|
Argument |
Description |
|
AliasNames |
An array of the string part of the AliasName, that is to be deleted. |
|
TargetNodes |
An array of the NodeId of the node that is the target of the AliasName, which would further restrict what is deleted. Each element in this array corresponds to an element at the same index in AliasNames. |
|
ErrorCodes |
Reports any error associate with the deletion of each AliasName. The size of the array shall be the same as the size of the AliasNames parameter. |
The length of each of the arrays shall be the same.
If the TargetNodes array entry is null or empty, all AliasNames with the provided name are deleted from the AliasNameCategory. If all targets for an AliasNames array entry cannot be deleted, then none of the targets are deleted.
The list of StatusCodes that could be returned in ErrorCodes is defined in Table 14
Table 14 – DeleteAliasesFromCategory return ErrorCodes
|
Result Code |
Description |
|
Bad_NotFound |
The AliasName was not found. |
|
Bad_InvalidState |
The AliasName being deleted is not from the local Server. |
Method result codes are defined in Table 15
Table 15 – DeleteAliasesFromCategory Method Error Codes
|
Result Code |
Description |
|
Bad_InvalidArgument |
An argument is of the wrong type or the size of the arrays for all arguments is not the same |
|
Bad_UserAccessDenied |
The current user does not have the required rights to delete an AliasName |
The Method is formally defined in Table 16.
Table 16 – DeleteAliasesFromCategory Method AddressSpace definition
|
Attribute |
Value |
||||
|
BrowseName |
DeleteAliasesFromCategory |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
HasProperty |
Variable |
InputArguments |
Argument[] |
PropertyType |
Mandatory |
|
HasProperty |
Variable |
OutputArguments |
Argument[] |
PropertyType |
Mandatory |
|
ConformanceUnits |
|||||