RegDeleteValue function

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

Syntax


LONG WINAPI RegDeleteValue(
  _In_      HKEY hKey,
  _In_opt_  LPCTSTR lpValueName
);

Parameters

hKey [in]

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 [in, optional]

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]

Header

Winreg.h (include Windows.h)

Library

Advapi32.lib

DLL

Advapi32.dll

Unicode and ANSI names

RegDeleteValueW (Unicode) and RegDeleteValueA (ANSI)

See also

Registry Functions
Registry Overview
RegSetValueEx

 

 

Community Additions

ADD
Show:
© 2014 Microsoft