RegDeleteValue

Overview

Group

Quick Info

Windows NT
Yes
Win95
Yes
Win32s
No
Import Library
advapi32.lib
Header File
winreg.h
Unicode
WinNT
Platform Notes
None

The RegDeleteValue function removes a named value from the specified registry key.

LONG RegDeleteValue(

HKEY hKey,	// handle of key
LPCTSTR lpValueName	// address of value name
);

Parameters
hKey

Identifies 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

Points to a null-terminated string that names the value to remove. If this parameter is NULL or points to an empty string, the value set by the RegSetValue function is removed.

Return Values
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.

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).