RegDeleteKey
Windows
95: The RegDeleteKey function
deletes a key and all its descendents.
Windows
NT: The RegDeleteKey function
deletes the specified key. This function cannot delete a key that has subkeys.
LONG RegDeleteKey(
|
HKEY hKey, |
// handle of open
key |
|
LPCTSTR lpSubKey |
// address of name
of subkey to delete |
|
); |
|
Parameters
hKey
Identifies a
currently open key or any of the following predefined reserved handle values:
HKEY_CLASSES_ROOT
HKEY_CURRENT_USER
HKEY_LOCAL_MACHINE
HKEY_USERS
The key specified by the lpSubKey parameter must be a subkey of
the key identified by hKey.
lpSubKey
Points to a
null-terminated string specifying the name of the key to delete. This parameter
cannot be NULL, and the specified key must not have subkeys.
Return Values
If the
function succeeds, the return value is ERROR_SUCCESS.
If the
function fails, the return value is a nonzero error code defined in WINERROR.H.
You can use the FormatMessage
function with the FORMAT_MESSAGE_FROM_SYSTEM flag to get a generic description
of the error.
Remarks
If the
function succeeds, RegDeleteKey removes the specified key from the
registry. The entire key, including all of its values, is removed.
To open the key,
use the RegCreateKeyEx or RegOpenKeyEx function. Do not use the RegCreateKey
or RegOpenKey functions.
See Also