The optional ClearStoredVariables Method allows a Client to clear the Variable from the list of Variables that are to be restored.
The signature of this Method is specified below; the arguments are defined in Table 52.
Signature
ClearStoredVariables (
[in] 0:NodeId[] VariablesToClear,
[out] 0:StatusCode[]Results
);
Table 52 – ClearStoredVariables Method arguments
Argument |
Description |
VariablesToClear |
An array of NodeId containing configuration data variables. |
Results |
An array of StatusCode corresponding to the VariablesToClear input argument that indicates any errors that occurred during the processing of VariablesToClear. If this array is populated, it has the same length as the VariablesToClear array. For possible values in this array, see Table 54. |
The possible Method result codes are formally defined in Table 53.
Table 53 – ClearStoredVariables Method result codes
Result Code |
Description |
Uncertain |
There was at least one error while processing the Variables to be cleared. Results will contain additional information. |
The Results StatusCodes are formally defined in Table 54.
Table 54 – Results StatusCodes
Result Code |
Description |
Bad_InvalidArgument |
The NodeId is not a ConfigurationData Variable or does not belong to this FunctionalEntity or one of its SubFunctionalEntities. |
Bad_NotSupported |
The NodeId specifies a Variable that is non-volatile or does not have storage for the Variable. |
Good |
Clearing the storage for this Variable succeeded. |
The ClearStoredVariables Method representation in the AddressSpace is formally defined in Table 55.
Table 55 – ClearStoredVariables Method AddressSpace definition
Attribute |
Value |
||||
BrowseName |
3:ClearStoredVariables |
||||
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 |
ConformanceUnits |
|||||
UAFX ConfigurationDataFolder VariableStorage |