This topic has not yet been rated - Rate this topic

SHDeleteEmptyKey function

Applies to: desktop apps only

Deletes an empty key.

Syntax

Copy

LSTATUS SHDeleteEmptyKey(
  __in      HKEY hkey,
  __in_opt  LPCTSTR pszSubKey
);

Parameters

hkey [in]

Type: HKEY

A handle to the currently open key, or any of the following predefined values.

HKEY_CLASSES_ROOT
HKEY_CURRENT_CONFIG
HKEY_CURRENT_USER
HKEY_LOCAL_MACHINE
HKEY_PERFORMANCE_DATA
HKEY_USERS

pszSubKey [in, optional]

Type: LPCTSTR

The address of a null-terminated string specifying the name of the key to delete.

Return value

Type: LSTATUS

Returns ERROR_SUCCESS if successful, or a nonzero error code defined in Winerror.h otherwise. You can use the FormatMessage function with the FORMAT_MESSAGE_FROM_SYSTEM flag to retrieve a generic description of the error.

Remarks

SHDeleteEmptyKey will not delete a key if it contains any subkeys or values. Use SHDeleteKey instead.

Requirements

Minimum supported client	Windows 2000 Professional, Windows XP
Minimum supported server	Windows 2000 Server
Header	Shlwapi.h
Library	Shlwapi.lib
DLL	Shlwapi.dll (version 4.71 or later)
Unicode and ANSI names	SHDeleteEmptyKeyW (Unicode) and SHDeleteEmptyKeyA (ANSI)

Send comments about this topic to Microsoft

Build date: 3/7/2012

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ