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

  • Статья

Извлекает значение реестра.

Синтаксис

LSTATUS SHGetValueA(
  [in]                HKEY   hkey,
  [in, optional]      LPCSTR pszSubKey,
  [in, optional]      LPCSTR pszValue,
  [out, optional]     DWORD  *pdwType,
  [out, optional]     void   *pvData,
  [in, out, optional] DWORD  *pcbData
);

Параметры

[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, которая указывает имя подраздела, из которого извлекается значение.

[in, optional] pszValue

Тип: LPCTSTR

Адрес значения.

[out, optional] pdwType

Тип: LPDWORD

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

[out, optional] pvData

Тип: LPVOID

Адрес буфера данных назначения.

[in, out, optional] pcbData

Тип: LPDWORD

Размер целевого буфера данных.

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

Тип: LSTATUS

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

Комментарии

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

Примечание

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

Требования

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