Edit

Share via

SHRegDeleteUSValueA function (shlwapi.h)

  • Article

Deletes a registry subkey value in a user-specific subtree (HKEY_CURRENT_USER or HKEY_LOCAL_MACHINE).

Syntax

LSTATUS SHRegDeleteUSValueA(
  [in] HUSKEY         hUSKey,
  [in] LPCSTR         pszValue,
  [in] SHREGDEL_FLAGS delRegFlags
);

Parameters

[in] hUSKey

Type: HUSKEY

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

This handle can be obtained through the SHRegOpenUSKey function.

[in] pszValue

Type: LPCTSTR

A pointer to the null-terminated string that names the value to remove.

[in] delRegFlags

Type: SHREGDEL_FLAGS

One of the SHREGDEL_FLAGS that specifies from which base key the value will be deleted.

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

Note

The shlwapi.h header defines SHRegDeleteUSValue as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header shlwapi.h
Library Shlwapi.lib
DLL Shlwapi.dll (version 4.71 or later)

See also

SHRegDeleteEmptyUSKey