Функция SHSetValueA (shlwapi.h)

Статья
03/02/2024

Задает значение раздела реестра.

Синтаксис

LSTATUS SHSetValueA(
  [in]           HKEY    hkey,
  [in, optional] LPCSTR  pszSubKey,
  [in, optional] LPCSTR  pszValue,
  [in]           DWORD   dwType,
  [in, optional] LPCVOID pvData,
  [in]           DWORD   cbData
);

Параметры

[in] hkey

Тип: HKEY

Дескриптор открытого в данный момент ключа или любое из следующих предопределенных значений.

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA

HKEY_USERS

[in, optional] pszSubKey

Тип: LPCTSTR

Адрес строки, заканчивающейся null, которая указывает имя подраздела, с которым связано значение. Это может быть null или указатель на пустую строку. В этом случае значение добавляется к ключу, определяемого параметром hkey .

[in, optional] pszValue

Тип: LPCTSTR

Адрес строки, заканчивающейся null, которая задает значение . Это значение может иметь значение NULL.

[in] dwType

Тип: DWORD

Тип хранимых данных. Этот параметр должен быть типом REG_SZ . Дополнительные сведения см. в разделе Типы данных реестра.

[in, optional] pvData

Тип: LPCVOID

Указатель на буфер, содержащий данные, заданные для указанного значения. Это значение может иметь значение NULL.

[in] cbData

Тип: DWORD

Длина (в байтах) буфера, на который указывает параметр pvData . Если данные являются строкой, заканчивающейся null, эта длина включает в себя завершающий символ NULL.

Возвращаемое значение

Тип: LSTATUS

В случае успешного выполнения возвращает ERROR_SUCCESS; в противном случае — ненулевой код ошибки, определенный в Winerror.h. Чтобы получить общее описание ошибки, можно использовать функцию FormatMessage с флагом FORMAT_MESSAGE_FROM_SYSTEM.

Заголовок shlwapi.h определяет SHSetValue как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора UNICODE. Сочетание использования псевдонима, не зависящий от кодировки, с кодом, не зависящим от кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional, Windows XP [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	shlwapi.h
Библиотека	Shlwapi.lib
DLL	Shlwapi.dll (версия 4.71 или более поздняя)