result values of agents::UninstallPlugin More...

#include <plugin_install_result.hpp>

Public Types
enum class	Result { SUCCESS , ERROR_PLUGIN_IN_USE , ERROR_INTERNAL_PLUGIN_DOES_NOT_EXIST , ERROR_WHILE_UPDATING_PLUGINS_AFTER_UNINSTALL , ERROR_NO_ACTION_TAKEN }
	describes the possible results of a plugin uninstallation More...

Public Member Functions
	PluginUninstallResult ()
	PluginUninstallResult (Result result, const std::filesystem::path &backup)
	constructs from the given result, in addition a path is provided the points to a backup of the uninstalled plugin. The backup can later be used to restore the persistent subfolder that may contain e. g. license files

Public Attributes
Result	result
	contains the uninstallation result
std::filesystem::path	backup
	may contain a path to a backup of the uninstalled plugin. This can be later used to restore the persistent subfolder containing e. g. license files.

Detailed Description

result values of agents::UninstallPlugin

Member Enumeration Documentation

◆ Result

enum class nexuslua::PluginUninstallResult::Result

strong

describes the possible results of a plugin uninstallation

Enumerator
SUCCESS
ERROR_PLUGIN_IN_USE	this application (or another process) currently uses the plugin, so it cannot be deleted. Tell user to quit and manually delete plugin directory AgentPlugin::GetPath()
ERROR_INTERNAL_PLUGIN_DOES_NOT_EXIST	the plugin name is not one of the names returned by AgentPlugin::GetName()
ERROR_WHILE_UPDATING_PLUGINS_AFTER_UNINSTALL
ERROR_NO_ACTION_TAKEN

Constructor & Destructor Documentation

◆ PluginUninstallResult() [1/2]

nexuslua::PluginUninstallResult::PluginUninstallResult ( )

inline

◆ PluginUninstallResult() [2/2]

nexuslua::PluginUninstallResult::PluginUninstallResult	(	Result	result,
		const std::filesystem::path &	backup )

inline

constructs from the given result, in addition a path is provided the points to a backup of the uninstalled plugin. The backup can later be used to restore the persistent subfolder that may contain e. g. license files

Member Data Documentation

◆ backup

std::filesystem::path nexuslua::PluginUninstallResult::backup

may contain a path to a backup of the uninstalled plugin. This can be later used to restore the persistent subfolder containing e. g. license files.

◆ result

Result nexuslua::PluginUninstallResult::result

contains the uninstallation result

The documentation for this struct was generated from the following file:

src/interface/nexuslua/plugin_install_result.hpp

Public Types

Public Member Functions

Public Attributes