Метод IRegistryKey::QueryValueKey (portcls.h)

Статья
02/29/2024

Метод QueryValueKey получает сведения о записях значения раздела реестра, включая их имена, типы, размеры данных и значения.

Синтаксис

NTSTATUS QueryValueKey(
  [in]  PUNICODE_STRING             ValueName,
  [in]  KEY_VALUE_INFORMATION_CLASS KeyValueInformationClass,
  [out] PVOID                       KeyValueInformation,
  [in]  ULONG                       Length,
  [out] PULONG                      ResultLength
);

Параметры

[in] ValueName

Указатель на указанное производителем имя записи значения. Строка имени определяется структурой типа UNICODE_STRING.

[in] KeyValueInformationClass

Указывает тип информации, возвращаемой в буфере. Задайте для этого параметра одно из следующих значений перечисления KEY_VALUE_INFORMATION_CLASS:

KeyValueBasicInformation
KeyValueFullInformation
KeyValuePartialInformation

[out] KeyValueInformation

Указатель на выделенный вызывающим буфером, в который метод записывает запрошенные данные. Буфер содержит структуру типа KEY_VALUE_BASIC_INFORMATION, KEY_VALUE_FULL_INFORMATIONили KEY_VALUE_PARTIAL_INFORMATIONв зависимости от значения KeyValueInformationClass. За структурой следует дополнительные данные, размер которых зависит от типа данных значения ключа.

[in] Length

Размер в байтах буфера KeyValueInformation, который вызывающий объект должен задать в соответствии с заданным KeyValueInformationClass. Чтобы получить все запрошенные данные, буфер должен иметь по крайней мере размер запрошенных данных.

[out] ResultLength

Указатель вывода для длины полученных данных. Этот параметр указывает на выделенную абонентом переменную ULONG, в которую метод записывает количество байтов, фактически записанных в буфер KeyValueInformation. Если указанная длина буфера слишком мала, чтобы содержать сведения, метод вместо этого выводит необходимый размер буфера и возвращает STATUS_BUFFER_OVERFLOW или STATUS_BUFFER_TOO_SMALL. Дополнительные сведения см. в следующем разделе "Примечания".

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

QueryValueKey возвращает STATUS_SUCCESS, если вызов выполнен успешно при копировании запрошенных сведений в буфер KeyValueInformation. Если указанный размер буфера слишком мал, чтобы получить все запрошенные сведения, метод возвращает STATUS_BUFFER_OVERFLOW. Если указанный размер буфера слишком мал, чтобы получить любую из запрошенных сведений, метод возвращает STATUS_BUFFER_TOO_SMALL. В противном случае метод возвращает соответствующий код состояния ошибки. В следующей таблице показаны некоторые возможные коды ошибок.

Возвращаемый код	Описание
STATUS_INVALID_PARAMETER	Указывает, что один из параметров, переданных методу, недопустим.
STATUS_OBJECT_NAME_NOT_FOUND	Указывает, что запись значения с указанным именем не найдена.

Замечания

Если буфер KeyValueInformation слишком мал для хранения запрошенной информации, метод записывает требуемый размер в *ResultLength и возвращает код состояния STATUS_BUFFER_OVERFLOW или STATUS_BUFFER_TOO_SMALL. Метод возвращает STATUS_BUFFER_OVERFLOW, если он успешно написал только часть запрошенной информации в буфер. Метод возвращает STATUS_BUFFER_TOO_SMALL, если не удалось записать данные в буфер. Значение, записанное в *ResultLength, указывает минимальный размер буфера, необходимый для хранения всех запрошенных сведений.