7.16.6 UnloadByName Method
The signature of this Method is specified below.
Signature
UnloadByName (
[in] 0:String Name
[out] 0:Int32 Status
);Table 83 specifies the Arguments.
| Argument | Description |
| Name | Name of the module to be unloaded |
| Status | 0 – OK – Everything is OK 1 – E_SystemState – The system is not in correct state for this operation 2 – E_UnexpectedError – Unexpected Error during the method call 3 – E_ActiveAlarm – An Active Alarm prevents the system start 4 – E_AcknowledgeRequired – Condition needs to be acknowledged <0 – shall be used for vendor-specific errors. >0 – are reserved for errors defined by this and future standards |
The UnloadByName Method is called by a Client to unload a module from a task control. This can be used to unload the task modules if they are not expressed in the address space and internal logic is used to find the module to be unloaded based on the Name input argument.
This method might not always result in a state change from Ready to Idle.
The possible Method result codes are formally defined in the table below.
| Result Code | Description |
| Good | The task control operation succeeded |
| Bad_InternalError | The task control operation failed because of an internal error |
| Bad_ResourceUnavailable | The Method is locked by another Client/Clientgroup |
| Bad_UserAccessDenied | The caller is not allowed to call this Method. |
The UnloadByName Method representation in the AddressSpace is formally defined in the table below.
| Attribute | Value | ||||
| BrowseName | UnloadByName | ||||
| References | NodeClass | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| 0:HasProperty | Variable | 0:InputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
| 0:HasProperty | Variable | 0:OutputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
| ConformanceUnits | |||||
|---|---|---|---|---|---|
| Rob Task Control Operation |