Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Group

Utilities

Description

Uninstalls

Uninstall RT-LAB on the specified target. The full path of the log created during the uninstallation is returned by the function.

When uninstalling the default RT-LAB running in the node, the uninstallation process will detect if other RT-LAB versions are present. If a valid RT-LAB version is found, then the uninstallation will uninstall the default RT-LAB version and set the latest remaining version as the default RT-LAB version.

Required Control

None

Usage

logFileName = RtlabApi.UninstallRtlab(nodeName)

logFileName = RtlabApi.UninstallRtlab(nodeName, rtlabVersion)

Input

  • nodeName: The RT-LAB node where the uninstallation will be

perfomed
  • performed

  • rtlabVersion: The RT-LAB version to be uninstalled. This argument in optional. If no RT-LAB version is passed as argument, then the default RT-LAB running in the node will

uninstalled 
  • uninstall 

Output

  • logFileName: The full path to the uninstallation log file

Return Value

  • EOK: Success

  • EINVAL:

 Invalid
  •  Invalid arguments specified

Examples

None

Related Items

None

Modules

import RtlabApi