RegDeleteKey

This function deletes a named subkey from the specified registry key. The subkey to be deleted cannot have any subkeys.

A remote application interface (RAPI) version of this function exists, and it is called CeRegDeleteKey.

At a Glance

Header file:	Winreg.h
Windows CE versions:	1.0 and later

Syntax

LONG RegDeleteKey( HKEY hKey, LPCWSTR lpszSubKey );

Parameters

hKey

[in] Handle to a currently open key or one 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

[in] Pointer to a null-terminated string specifying the name of the key to delete. This parameter cannot be NULL.

Return Values

ERROR_SUCCESS indicates success. A nonzero error code defined in Winerror.h indicates failure. To get a generic description of the error, call FormatMessage with the FORMAT_MESSAGE_FROM_SYSTEM flag set.

Remarks

If the function succeeds, RegDeleteKey removes the specified key from the registry. The entire key, including all of its values, is removed. An application cannot call RegDeleteKey for a key that an application currently has open.

To open the key, use the RegCreateKeyEx or RegOpenKeyEx function.