CeRegDeleteKey (RAPI)

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function deletes a subkey from the specified registry key on a remote Windows Embedded CE–based device. The subkey to be deleted cannot have any subkeys.

Syntax

LONG CeRegDeleteKey( 
  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.

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

Return Value

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, CeRegDeleteKey removes the specified key from the registry. The entire key, including all of its values, is removed. An application cannot call CeRegDeleteKey for a key that an application currently has open.

To open the key, use the CeRegCreateKeyEx or CeRegOpenKeyEx function.

Requirements

See Also

Reference

RAPI Functions
CeRegCloseKey (RAPI)
CeRegCreateKeyEx (RAPI)
CeRegOpenKeyEx (RAPI)