RegDBQueryKey

InstallShield 2024 » InstallScript Language Reference

Project: For InstallScript MSI and Basic MSI projects, it is recommended that you use the Registry view in InstallShield instead of creating registry keys and values through InstallScript code. Handling all of your registry changes in this way allows for a clean uninstallation through the Windows Installer service.

The RegDBQueryKey function allows users to query a key for its subkeys and value names. The keys can be enumerated dynamically at run time using this function. RegDBQueryKey is a general registry-related function, designed to work with all registry keys, including those handled by the special registry-related functions.

Note:This function supports the 64-bit parts of the registry by using the REGDB_OPTION_WOW64_64KEY option. For more information, see REGDB_OPTIONS.

Syntax

RegDBQueryKey ( szSubKey, nItem, listResults );

Parameters

RegDBQueryKey Parameters

Parameter

Description

szSubKey

Specifies subkeys under one of the root keys that were set by a previous call to RegDBSetDefaultRoot. Use backslashes to specify deeper levels of subkeys. To retrieve the root key, pass a null string (“”).

nItem

Specifies which items should be placed in the list. Pass one of the following predefined constants in this parameter:

•

REGDB_KEYS—The string list returned in listResults will contain a list of all the subkeys under this key.

•

REGDB_NAMES—The string list returned in listResults will contain the names of all named values for this key.

listResults

Returns the results of the query in a string list. The list identified by listResults must already have been initialized by a call to ListCreate.

Return Values

RegDBQueryKey Return Values
Return Value	Description
0	Indicates function was successful.
< 0	Indicates function failed.

Additional Information

By default, any text that is surrounded by angle brackets—for example, "<my registry entry text>"—in this function’s string arguments is interpreted as a text substitution and is processed accordingly. To disable text substitution processing for the string arguments of registry functions, call Disable with the REGISTRYFUNCTIONS_USETEXTSUBS argument.