9.1.4.3.3 RemoveVariables Method
This Method is used to remove Variables from the PublishedData list. It contains the list of published Variables of a PublishedDataItemsType Object.
A caller shall read the current Values of PublishedData and ConfigurationVersion prior to calling this Method, to ensure the use of the correct index of the Variables that are being removed.
If at least one Variable was successfully removed from the PublishedData, the MajorVersion of the ConfigurationVersion shall be updated. The ConfigurationVersionDataType and the rules for setting the version are defined in 6.2.3.2.6.
The order of the remaining Variables in the PublishedData shall be preserved.
The Client shall be authorized to modify the configuration for the PubSub functionality when invoking this Method on the Server.
Signature
RemoveVariables (
[in] ConfigurationVersionDataType ConfigurationVersion,
[in] UInt32[] VariablesToRemove,
[out] ConfigurationVersionDataType NewConfigurationVersion,
[out] StatusCode[] RemoveResults
);
| Argument | Description |
| ConfigurationVersion | Configuration version of the DataSet. The configuration version and the indices passed through VariablesToRemove shall match the entire current configuration version of the Object when the Method call is processed. If it does not match, the result Bad_InvalidState shall be returned. The ConfigurationVersionDataType is defined in 6.2.3.2.6. |
| VariablesToRemove | Array of indices of Variables to remove from the list of Variables configured in PublishedData of the PublishedDataItemsType. This matches the list of fields configured in the DataSetMetaData of the PublishedDataSetType. |
| NewConfigurationVersion | Returns the new configuration version of the DataSet. |
| RemoveResults | The result codes for each of the variables to remove. |
Method Result Codes
| ResultCode | Description |
| Bad_NothingToDo | An empty list of variables was provided. |
| Bad_InvalidState | The configuration version did not match the current state of the Object. |
| Bad_UserAccessDenied | The Session user is not allowed to configure the Object. |
Operation Result Codes
| ResultCode | Description |
| Bad_InvalidArgument | The passed index was invalid. |
Table 255 specifies the AddressSpace representation for the RemoveVariables Method.
| Attribute | Value | ||||
| BrowseName | RemoveVariables | ||||
| References | NodeClass | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| HasProperty | Variable | InputArguments | Argument[] | PropertyType | Mandatory |
| HasProperty | Variable | OutputArguments | Argument[] | PropertyType | Mandatory |
| ConformanceUnits | |||||
|---|---|---|---|---|---|
| PubSub Model PublishedDataSet |