Shiny Language Reference

Language Reference > Registry Functions


deleteprofilevalue

bool deleteprofilevalue(string Value);

 

Synonyms:

bool delpvalue(string Value);

 

Deletes a value from the the registry profile for the plugin

DELETEPROFILEVALUE deletes the value with the specified name in the registry key for this plugin. When a new SSE is loaded by Brass, a registry key is created for it under HKCU\Software\32Bits\Brass\Shiny<plugin_filename>. This key is used to store the position, size and configuration of the display panel as well as associated settings that all plugins have access to (for example, hotkeys). Plugins may read values from and write values to this registry key to manage their configuration and internal settings. The standard registry profile functions are not designed for general-purpose registry access. Instead they are intended to allow plugins to store configuration and ensure that any such configuration stored is unique to the plugin instance. This is why the registry functions do not allow the selection of registry keys. Refer to GETSELFNAME for more information on unique instances.

This statement is only valid in the RegRead or RegWrite handler

 

Parameters

Value

The name of the registry value to delete.

 

Return Value

TRUE indicates success, FALSE indicates failure.

 

Example Code

// Delete the HiScore value from the registry
bool Result = deleteprofilevalue("HiScore");