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

Статья
02/07/2025

Метод EnumerateValueKey возвращает сведения о записи реестра, содержащей ключ значения.

Синтаксис

NTSTATUS EnumerateValueKey(
  [in]  ULONG                       Index,
  [in]  KEY_VALUE_INFORMATION_CLASS KeyValueInformationClass,
  [out] PVOID                       KeyValueInformation,
  [in]  ULONG                       Length,
  [out] PULONG                      ResultLength
);

Параметры

[in] Index

Задает индекс подраздела. Этот параметр определяет подраздел, значение которого запрашивается. Если ключ содержит n подразделов, допустимые индексы варьируются от 0 до n-1. Если индекс превышает этот диапазон, метод возвращает STATUS_NO_MORE_ENTRIES.

[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.

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

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

Возвращаемый код	Описание
STATUS_BUFFER_TOO_SMALL	Указывает, что указанный буфер слишком мал, чтобы получить любую информацию.
STATUS_INVALID_PARAMETER	Указывает, что один из параметров, переданных методу, недопустим.
STATUS_NO_MORE_ENTRIES	Указывает, что нет дополнительных ключей значений (параметр индекса больше или равен числу ключей значений).