View source for API:ModuleRemoveSavedVariable

{{LuaApi|group=Module}}
Removes a saved variable from a UI module at run time.

<pre>
ModuleRemoveSavedVariable(moduleName, variableName)
</pre>

== Arguments ==
;moduleName : <code>string</code> – The module's name, as in the <code>name</code> field of [[API:ModulesGetData|ModulesGetData]].
;variableName : <code>string</code> – Name of the saved variable, exactly as it was registered.

== Returns ==
Nothing.

== Details ==
* If the module has no saved variable with that name, the ''does not have a saved variable'' error is logged.
* As with [[API:ModuleAddSavedVariable|ModuleAddSavedVariable]], the change is accepted only while the module is initialized or being initialized. Otherwise the ''is not loaded'' error is logged; its wording does not match the check.
* The function needs at least two arguments and only reads the last two.
* The stock UI never calls <code>ModuleRemoveSavedVariable</code>.

== Errors ==
These are written to the UI log; the call returns normally.
* <code>Error in function call 'ModuleRemoveSavedVariable': %s is not a valid UiMod name.</code>
* <code>Error in function call 'ModuleRemoveSavedVariable': %s is not loaded. You may not modify the SavedVariables on a Module that is initialized.</code>
* <code>Error in function call 'ModuleRemoveSavedVariable': %s does not have a saved variable named '%s'.</code>

== Example ==
A minimal example built from the signature above:
<pre>
ModuleRemoveSavedVariable( "MyAddon", "MyAddon.Settings" )
</pre>

== See also ==
* [[API:ModuleAddSavedVariable|ModuleAddSavedVariable]]
* [[API:ModulesSaveSettings|ModulesSaveSettings]]