SHRegSetValue function (shlwapi.h)

Article
07/27/2022

Not supported.

Sets a registry value.

Use RegSetValue in its place.

Syntax

LSTATUS SHRegSetValue(
  [in] HKEY    hkey,
  [in] LPCWSTR pszSubKey,
  [in] LPCWSTR pszValue,
  [in] SRRF    srrfFlags,
  [in] DWORD   dwType,
  [in] LPCVOID pvData,
  [in] DWORD   cbData
);

Parameters

[in] hkey

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

[in] pszSubKey

Type: LPCWSTR

A pointer to a null-terminated string that specifies the relative path from hkey to the subkey from which to retrieve the value. This parameter can be NULL or an empty string, in which case the data is retrieved from the hkey location.

[in] pszValue

Type: LPCWSTR

A pointer to a null-terminated string that contains the name of the value. This parameter can be NULL or an empty string, in which case the data is retrieved from the Default value.

[in] srrfFlags

Type: SRRF

One or more of the SRRF flags that restricts the data to be set. At least one type restriction (SRRF_RT) value must be specified.

[in] dwType

Type: DWORD

The DWORD that indicates the type of data stored in the value to be set. When using default values, the input dwType is the type of the default value. For possible values, see Registry Data Types. If the SRRF_NOEXPAND flag is not set, REG_EXPAND_SZ types are automatically expanded and returned as REG_SZ. If type information is not required, this parameter can be NULL.

[in] pvData

Type: LPCVOID

A pointer to a buffer that contains the value's data. This parameter can be NULL if the data is not needed.

[in] cbData

Type: DWORD

The size of the source data buffer pvData, in bytes. This value can be NULL only if pvData is NULL.

Return value

Type: LONG

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.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	shlwapi.h (include Shlwapi.h)
DLL	Shlwapi.dll

Share via