RegDeleteValue

This function removes a named value from the specified registry key. A remote application interface (RAPI) version of this function exists, and it is called CeRegDeleteValue.

LONG RegDeleteValue( 
HKEY hKey, 
LPCWSTR lpValueName ); 

Parameters

  • hKey
    [in] Handle to a currently open key or any of the following predefined reserved handle values:
    • HKEY_CLASSES_ROOT
    • HKEY_CURRENT_USER
    • HKEY_LOCAL_MACHINE
    • HKEY_USERS
  • lpValueName
    [in] Pointer to a null-terminated string that names the value to remove. If this parameter is NULL or points to an empty string, the default value of the key is removed. A default value is create by calling RegSetValueEx with a NULL or empty string value name.

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. The message resource is optional; therefore, if you call FormatMessage it could fail.

Remarks

The key identified by the hKey parameter must have been opened with KEY_SET_VALUE access (KEY_WRITE access includes KEY_SET_VALUE access).

Requirements

Runs on Versions Defined in Include Link to
Windows CE OS 1.0 and later Winreg.h   Coredll.lib, Fsreg.lib

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

RegSetValueEx

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.