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

Статья
11/20/2024

Устаревшие. Открывает значение реестра и предоставляет поток, который можно использовать для чтения или записи в значение.

Примечание Эта функция заменена SHOpenRegStream2. Рекомендуется использовать SHOpenRegStream2.

Синтаксис

IStream * SHOpenRegStreamA(
  [in]           HKEY   hkey,
  [in, optional] LPCSTR pszSubkey,
  [in, optional] LPCSTR pszValue,
  [in]           DWORD  grfMode
);

Параметры

[in] hkey

Тип: HKEY

Обязательно. Поддерев, например HKEY_LOCAL_MACHINE, который содержит значение.

[in, optional] pszSubkey

Тип: LPCTSTR

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

[in, optional] pszValue

Тип: LPCTSTR

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

[in] grfMode

Тип: DWORD

Тип доступа для потока. Это может быть одно из следующих значений:

STGM_READ

Откройте поток для чтения.

STGM_WRITE

Откройте поток для записи.

STGM_READWRITE

Откройте поток для чтения и записи.

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

Тип: IStream*

Возвращает указатель интерфейса IStream в случае успешного выполнения; в противном случае NULL. Значение NULL может быть вызвано несколькими ситуациями, включая недопустимый или pszSubkeyили неспособность открыть поток.

Примечание В некоторых ситуациях, например если вложенный ключ с именем pszSubkey не существует, или вызывающий объект не имеет достаточных разрешений для доступа к подразделу, возвращается поток нулевой длины, а не значение NULL. SHOpenRegStream2 возвращает NULL во всех ситуациях ошибок и является предпочтительной функцией по этой причине.

Замечания

Вызывающее приложение отвечает за вызов метода Release возвращаемого объекта, если этот объект IStream больше не нужен.

Заметка

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

Требования

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

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