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

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

  • Статья

Задает значение подраздела реестра в поддереве для конкретного пользователя (HKEY_CURRENT_USER или HKEY_LOCAL_MACHINE).

Синтаксис

LSTATUS SHRegSetUSValueA(
  [in]           LPCSTR     pszSubKey,
  [in]           LPCSTR     pszValue,
  [in]           DWORD      dwType,
  [in, optional] const void *pvData,
  [in, optional] DWORD      cbData,
  [in, optional] DWORD      dwFlags
);

Параметры

[in] pszSubKey

Тип: LPCTSTR

Указатель на строку, завершаемую значением NULL, с именем подраздела.

[in] pszValue

Тип: LPCTSTR

Указатель на строку, завершающуюся значением NULL, которая указывает имя значения.

[in] dwType

Тип: DWORD

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

[in, optional] pvData

Тип: LPVOID*

Указатель на строку, завершающую значение NULL, содержащую значение, которое должно быть задано для указанного ключа.

[in, optional] cbData

Тип: DWORD

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

[in, optional] dwFlags

Тип: DWORD

Флаги, указывающие, где должны быть записаны данные.

SHREGSET_HKCU

Запись в HKEY_CURRENT_USER, если пуста.

SHREGSET_FORCE_HKCU

Запись в HKEY_CURRENT_USER.

SHREGSET_HKLM

Запись в HKEY_LOCAL_MACHINE, если пуста.

SHREGSET_FORCE_HKLM

Запись в HKEY_LOCAL_MACHINE.

SHREGSET_DEFAULT

Эквивалентно (SHREGSET_FORCE_HKCU | SHREGSET_HKLM).

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

Тип: LSTATUS

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

Замечания

Эта функция открывает ключ при каждом использовании. Если код включает настройку ряда значений в том же ключе, то более эффективно открыть ключ один раз с SHRegOpenUSKey, а затем использовать SHRegWriteUSValue для записи данных.

Заметка

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

Требования

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