Method

GPluginPluginget_desired_state

since: 0.38

Declaration [src] 

GPluginPluginState
gplugin_plugin_get_desired_state (
  GPluginPlugin* plugin
)

Description [src]

Gets the desired state of the plugin. Typically this will hold the same value of GPluginPlugin:state, but if a state change failed this will remain set to the state that was attempted.

For example, say a user wants to unload a plugin but the plugin can’t be unloaded for some reason. The state will be set to loaded, but the desired state will be set to unloaded.

This behavior can be used to give the user the ability to disable a plugin that normally isn’t unloadabled from being loaded during the next run of program.

Available since: 0.38

Gets propertyGPlugin.Plugin:desired-state

Return value

Type: GPluginPluginState

The desired state that the user has requested the plugin to be in.