RegistryDeleteValue

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function deletes a specified registry value.

Syntax

HRESULT WINAPI RegistryDeleteValue( 
  HKEY hKey
  LPCTSTR pszSubKey,
  LPCTSTR pszValueName
);

Parameters

• hKey
  Handle to a currently open key, or a predefined root value.

• pszSubKey
  The key under which the value is stored (if this value is NULL, pszValueName is assumed to be under hKey).

• pszValueName
  The name of the value to delete (if this parameter is NULL, the default value is deleted).

Return Value

Remarks

The value under the hKey+pszSubKey will be deleted if it exists, if the value does not exist, there is no change and this method will succeed.

If the key pointed to by hKey+pszSubKey does not exist, RegistryDeleteValue will fail since it uses RegOpenKey to access the key.

Code Example

The following code example demonstrates how to use RegistryDeleteValue.

void ClearRegistrySettings()
{
    HKEY hkey;
    // Clear one value from HKEY_LOCAL_MACHINE.
    RegistryDeleteValue(HKEY_LOCAL_MACHINE, 
                        TEXT("Software\\MyApplication"), 
                        TEXT("SystemValue"));
    // Re-use the HKEY_CURRENT_USER handle.
                 0, 
                 0, 
                 &hkey);
    RegistryDeleteValue(hkey, NULL, TEXT("UserValue1"));
    RegistryDeleteValue(hkey, NULL, TEXT("UserValue2"));
    // Clean up
    RegCloseKey(hkey);
}

Requirements

See Also

Reference

State and Notifications Broker Functions
State and Notifications Broker Reference

Other Resources

State and Notifications Broker