ssCore.Registry.enumKeys

Retrieve a list of all the child keys of the specified subkey.


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 whose children are to be enumerated. This key must be a subkey of the rootKey.


Output Parameters:

result - A list of subkeys separated by carriage return (\r) characters, or an empty string if there are no subkeys.


Asynchronous Mode:

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

ssCore.Registry.enumKeys( 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.enumKeys( paramsObject );


Notes:

None.


Examples:

var return_obj = ssCore.Registry.enumKeys({rootKey:"HKEY_CURRENT_USER", subKey:"Software"});

ssDebug.trace(return_obj.result);