Функция ORGetValue
Извлекает тип и данные для указанного значения реестра в автономном кусте реестра.
Синтаксис
DWORD ORGetValue(
_In_ ORHKEY Handle,
_In_opt_ PCWSTR lpSubKey,
_In_opt_ PCWSTR lpValue,
_Out_opt_ PDWORD pdwType,
_Out_opt_ PVOID pvData,
_Inout_opt_ PDWORD pcbData
);
Параметры
-
Дескриптор [в]
-
Дескриптор открытого раздела реестра в автономном кусте реестра.
-
lpSubKey [in, необязательный]
-
Имя раздела реестра. Этот ключ должен быть подразделом ключа, заданного параметром Handle . Этот параметр может принимать значение NULL.
В именах ключей регистр не учитывается.
-
lpValue [in, необязательный]
-
Имя значения реестра. Если этот параметр имеет значение NULL или пустую строку "", функция извлекает тип и данные для неименованного или значения по умолчанию ключа, если таковой имеется. Дополнительные сведения см. в разделе Ограничения размера элементов реестра.
Ключи не имеют автоматически неименованного значения или значения по умолчанию. Неименованные значения могут иметь любой тип.
В именах значений регистр не учитывается.
-
pdwType [out, optional]
-
Указатель на переменную, получающую код, указывающий тип данных, хранящихся в указанном значении. Список возможных кодов типов см. в разделе Типы значений реестра. Этот параметр может иметь значение NULL , если тип не является обязательным.
-
pvData [out, optional]
-
Указатель на буфер, получающий данные значения. Этот параметр может иметь значение NULL , если данные не требуются.
Если данные являются строкой, функция проверяет наличие завершающего символа NULL. Если он не найден, строка сохраняется с признаком конца null, если буфер достаточно велик для размещения дополнительного символа. В противном случае функция завершается сбоем и возвращает ERROR_MORE_DATA.
-
pcbData [in, out, optional]
-
Указатель на переменную, указывающую размер буфера, на который указывает параметр pvData , в байтах. Когда функция возвращает, эта переменная содержит размер данных, скопированных в pvData.
Параметр pcbData может иметь значение NULL , только если pvData имеет значение NULL.
Если данные имеют тип REG_SZ, REG_MULTI_SZ или REG_EXPAND_SZ, этот размер включает все завершающие символы NULL или символы. Дополнительные сведения см. в подразделе "Примечания".
Если буфер, заданный параметром pvData , недостаточно велик для хранения данных, функция возвращает ERROR_MORE_DATA и сохраняет требуемый размер буфера в переменной, на которую указывает pcbData. В этом случае содержимое буфера pvData не определено.
Если pvData имеет значение NULL, а pcbData — не NULL, функция возвращает ERROR_SUCCESS и сохраняет размер данных в байтах в переменной, на которую указывает pcbData. Это позволяет приложению определить оптимальный способ выделения буфера для данных значения.
Возвращаемое значение
Если функция выполнена успешно, возвращаемое значение будет ERROR_SUCCESS.
Если функция завершается сбоем, возвращаемое значение представляет собой код ошибки, отличный от нуля, определенный в Winerror.h. Чтобы получить общее описание ошибки, можно использовать функцию FormatMessage с флагом FORMAT_MESSAGE_FROM_SYSTEM.
Комментарии
Приложение обычно вызывает функцию OREnumValue для определения имен значений, а затем вызывает функцию ORGetValue для получения данных для имен.
Требования
| Требование | Значение |
|---|---|
| Распространяемые компоненты |
Библиотека автономного реестра Windows версии 1.0 или более поздней |
| Заголовок |
|
| DLL |
|
См. также раздел