CeRegDeleteKey

  • Article

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

CeRegDeleteKey is a RAPI that enables an application that is running on a desktop computer to make function calls on a Microsoft® Windows® CE–based device.

STDAPI_(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 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, 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

Smartphone Platforms: Smartphone 2002 and later
OS Versions: Windows CE 3.0 and later
Header: rapi.h
Library: rapi.lib

See Also

CeRegCloseKey

CeRegCreateKeyEx

CeRegOpenKeyEx

Last updated on Friday, April 22, 2005

© 2005 Microsoft Corporation. All rights reserved.

Send feedback on this topic to the authors.