RegDeleteValueW function

Removes a named value from the specified registry key. Note that value names are not case sensitive.

Syntax

LSTATUS RegDeleteValueW(
  HKEY    hKey,
  LPCWSTR lpValueName
);

Parameters

hKey

A handle to an open registry key. The key must have been opened with the KEY_SET_VALUE access right. For more information, see Registry Key Security and Access Rights.

This handle is returned by the RegCreateKeyEx, RegCreateKeyTransacted, RegOpenKeyEx, or RegOpenKeyTransacted function. It can also be one of the following predefined keys:


   HKEY_CLASSES_ROOT
   HKEY_CURRENT_CONFIG
   HKEY_CURRENT_USER
   HKEY_LOCAL_MACHINE
   HKEY_USERS

lpValueName

The registry value to be removed. If this parameter is NULL or an empty string, the value set by the RegSetValue function is removed.

For more information, see Registry Element Size Limits.

Return Value

If the function succeeds, the return value is ERROR_SUCCESS.

If the function fails, the return value is a nonzero error code defined in Winerror.h. You can use the FormatMessage function with the FORMAT_MESSAGE_FROM_SYSTEM flag to get a generic description of the error.

Requirements

   
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header winreg.h (include Windows.h)
Library Advapi32.lib
DLL Advapi32.dll

See Also

RegSetValueEx

Registry Functions

Registry Overview