Function

Summary

Returns names of the subkeys of a registry key.

Package

win32

Signature

collect-registry-subkeys subkey &key root max-name-size max-names errorp value-function => subsubkeys

Arguments

subkey

A string specifying the name of the key.

root

A keyword or handle.

max-name-size

An integer.

max-names

An integer.

errorp

A boolean.

value-function

A function designator or nil.

Values

subsubkeys

A list.

Description

The function collect-registry-subkeys returns a list of names which are subsubkeys of subkey under the key root.

subkey and root are interpreted as described for create-registry-key. The default value of root is :user.

max-name-size specifies the maximum length of the returned name. If the name is longer than this, an error is signaled. The default value of max-name-size is 256.

max-names specifies the maximum number of names returned. Names after this number are ignored. The default value of max-names is most-positive-fixnum.

If value-function is non-nil, it should be a function with signature

value-function handle subsubkey-name => name, collectp

value-function is funcalled for each subsubkey with the handle of subkey and the name of the subsubkey. If collectp is non-nil then name is collected into the list subsubkeys to return from collect-registry-subkeys. Otherwise it is ignored.

If value-function is nil, then the returned subsubkeys is a list of strings naming all (subject to max-names) of the subsubkeys. The default value of value-function is nil.

If an error occurs opening subkey and errorp is true then an error is signaled. Otherwise, subsubkeys is returned as nil if subkey could not be opened. The default value of errorp is t.

See also

collect-registry-values
create-registry-key