Contents Index Topic Contents
	Previous Topic: SHDeleteEmptyKey Next Topic: SHDeleteValue

SHDeleteKey

DWORD SHDeleteKey(
    HKEY     hkey,
    LPCTSTR  pszSubKey
    );

Deletes a subkey and all its descendants. The function will remove the key and all of the key's values from the registry.

• Returns ERROR_SUCCESS if successful, or a nonzero error code defined in Winerror.h otherwise. You can use the FormatMessage function with the FORMAT_MESSAGE_FROM_SYSTEM flag to get a generic description of the error.

hkey

Handle to the currently open key, or any of the following predefined values:

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_DYN_DATA (Windows 95 only)

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA (Windows NT only)

HKEY_USERS

pszSubKey

Address of a null-terminated string specifying the name of the key to delete.

Windows 95: This function deletes a subkey and all its descendants.

Windows NT: The specified key must not contain any subkeys.

---

 Top of Page
© 1997 Microsoft Corporation. All rights reserved. Terms of Use.