ssCore.Registry.deleteKey

Delete the specified key from the registry. The key, all its subkeys and all values will be removed.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

rootKey - The name of one of the main branches of the registry. Valid values include: HKEY_CLASSES_ROOT, HKEY_CURRENT_USER, HKEY_USERS, HKEY_LOCAL_MACHINE, HKEY_PERFORMANCE_DATA, HKEY_CURRENT_CONFIG, and HKEY_DYN_DATA.

subKey - The name of the key to be deleted. This key must be a subkey of the rootKey.


Output Parameters:

No output parameters.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.Registry.deleteKey( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.Registry.deleteKey( paramsObject );


Notes:

None.


Examples:

ssCore.Registry.deleteKey({rootKey:"HKEY_CURRENT_USER", subKey:"Software\\Test"});