This Method sets the Value of the ApplicationTag Variable. The security constraints defined in chapter 6.7 apply.
Signature
SetApplicationTag (
[in] 0:String ApplicationTag
);
Argument |
Description |
ApplicationTag |
String containing the desired content of the ApplicationTag Variable. |
The Method Result Codes (defined in Call Service) are defined in Table 31.
Table 31 – Possible Method result codes
Result Code |
Description |
Good |
The Method execution was successful. |
Bad_UserAccessDenied |
The user has not the right to execute the Method. |
Bad_InvalidArgument |
The Server is not able to apply the name. The ApplicationTag string may be too long or may contain invalid characters. The server may also reject duplicates. |
Bad_UnexpectedError |
The server is not able to execute the function because an unexpected error occurred. The Device might be temporarily unavailable or unreachable due to network failure. |
The Server might provide diagnosis data by sending RioChannelDiagnosisEventType Events and / or RioChannelDiagnosisAlarmType Events. The diagnosis data of the RioChannelGroup Object includes the diagnosis information of all aggregated RIO Channel Objects.
If the SetApplicationTag Method is invoked or if parameterization data provided by the subordinated RioChannelGroupConfigType Object is changed, the value of the LastParameterChange timestamp Variable shall be changed by the Server. This includes the EngineeringUnits and EURange Properties of Process Value Variables and any change of configuration data provided by the “Config” Objects.
The Lock Object ensures exclusive Method call for one Client. The Client locks the channel Object by invoking the InitLock Method of the Lock Object. The Client invokes ExitLock to release the lock.
Before invoking a Method of the channel Object, Clients must gain exclusive access (“lock” the channel Object) using the Lock Object.