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

Статья
11/20/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 или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows 2000 Профессиональный, Windows XP [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	shlwapi.h
библиотеки	Shlwapi.lib
DLL	Shlwapi.dll (версия 4.71 или более поздняя)

Поделиться через