The EditConnectionConfigurationSets Method manages the editing of ConnectionConfigurationSets by a Client.
The Method shall set the Edit Property to TRUE for the requested ConnectionConfigurationSets. For ConnectionConfigurationSets which are not editable (indicated by the absence of the Property Edit), this Method shall return Bad_InvalidState. For the ConnectionConfigurationSets that allow editing, the Method shall also set the Lock to the Client Session associated with this Method Call. The Lock shall behave as described in OPC 10000-100, including the requirement to renew the Lock and to remove the Lock in the case of the Client Session exiting. If the Lock exits for any reason, the internal action on the ConnectionConfigurationSets shall be as if this Method was called with a DiscardUpdates Action. For ConnectionConfigurationSet already in edit mode and locked to this Client Session, no action shall be performed on this ConnectionConfigurationSet, and a successful result is returned.
If Action is CommitUpdates, the Method shall set the Property Edit to FALSE for all requested ConnectionConfigurationSets. The ConnectionManager shall only process committed updates. It shall reassign the Lock back to the ConnectionManager. If Version is supported, it shall always be incremented; for additional behaviour, see Version in 6.8.2. If the requesting Client does not own the Lock, the request is rejected with an error.
If Action is DiscardUpdates, the Method shall set the Property Edit to FALSE for all requested ConnectionConfigurationSets. The ConnectionManager shall discard the updates to the ConnectionConfigurationSet. It shall reassign the Lock back to the ConnectionManager. If the requesting Client does not own the Lock, the request is rejected with an error.
If a ConnectionConfigurationSet is called with Action set to either CommitUpdates or DiscardUpdates, but the Edit Property is FALSE, the Method shall ignore the Call for the ConnectionConfigurationSet.
The signature of this Method is specified below. The Method parameters are defined in Table 76.
Signature
EditConnectionConfigurationSets (
[in] 4:FxEditEnum Action,
[in] 0:NodeId[] ConnectionConfigurationSets,
[out] 0:StatusCode[]Results
);
Table 76 – EditConnectionConfigurationSets Method arguments
|
Argument |
Description |
|
Action |
Indicates whether to allow editing, commit the updates to the ConnectionConfigurationSets or discard the updates. |
|
ConnectionConfigurationSets |
A list of NodeIds of ConnectionConfigurationSets to be edited. |
|
Results |
A list of StatusCode corresponding to the ConnectionConfigurationSets input argument. The length of this array shall match the length of the ConnectionConfigurationSets NodeId array. Clients may inspect this list to determine which ConnectionConfigurationSets were successfully updated and which failed. See Table 78 for possible Results values. |
The possible Method result codes are formally defined in Table 77.
Table 77 – EditConnectionConfigurationSets Method result codes
|
ResultCode |
Description |
|
Bad_UserAccessDenied |
The caller is not allowed to invoke this Method. |
|
Uncertain |
There was at least one error or warning for one of the ConnectionConfigurationSets. Results will contain additional information. |
The possible Results StatusCodes are formally defined in Table 78. The Results array shall contain Good for any ConnectionConfigurationSet that was successfully updated.
Table 78 – Results StatusCodes
|
ResultCode |
Description |
|
Good |
|
|
Bad_NodeIdUnknown |
The NodeId refers to a non-existent ConnectionConfigurationSet. |
|
Bad_NodeIdInvalid |
The syntax of the NodeId is not valid. |
|
Bad_InvalidArgument |
The NodeId for the requested ConnectionConfigurationSet was not a ConnectionConfigurationSet. |
|
Bad_UserAccessDenied |
The caller is not allowed to edit this ConnectionConfigurationSet. |
|
Bad_InvalidState |
The ConnectionConfigurationSet cannot be edited. The caller is not allowed to edit, commit, or discard updates since the ConnectionConfigurationSet is locked by a different Client. |
The EditConnectionConfigurationSets Method representation in the AddressSpace is formally defined in Table 79.
Table 79 – EditConnectionConfigurationSets Method AddressSpace definition
|
Attribute |
Value |
||||
|
BrowseName |
4:EditConnectionConfigurationSets |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
Other |
|
0:HasProperty |
Variable |
0:InputArguments |
0:Argument[] |
0:PropertyType |
M |
|
0:HasProperty |
Variable |
0:OutputArguments |
0:Argument[] |
0:PropertyType |
M |
|
0:GeneratesEvent |
ObjectType |
2:AuditUpdateMethodResultEventType |
Defined in 8.4 |
|
|
|
ConformanceUnits |
|||||
|
UAFX ConnectionManager EditConnectionConfigurationSets |
|||||