IRegistryKey：：QueryKey 方法 (portcls.h)

项目
02/26/2024

方法 QueryKey 检索有关注册表项的信息，包括密钥名称、键类以及子项的数量及其大小。

语法

NTSTATUS QueryKey(
  [in]  KEY_INFORMATION_CLASS KeyInformationClass,
  [out] PVOID                 KeyInformation,
  [in]  ULONG                 Length,
  [out] PULONG                ResultLength
);

参数

[in] KeyInformationClass

指定要在缓冲区中返回的信息的类型。将此参数设置为以下KEY_INFORMATION_CLASS枚举值之一：

KeyBasicInformation
KeyFullInformation
KeyNodeInformation

[out] KeyInformation

指向调用方分配的缓冲区的指针，方法在其中写入请求的数据。缓冲区保存 KEY_BASIC_INFORMATION、 KEY_FULL_INFORMATION或 KEY_NODE_INFORMATION类型的结构，具体取决于 KeyInformationClass 的值。结构后跟 Unicode 字符的字符串，其大小取决于所请求的有关密钥的信息类型和键的名称或类字符串的长度。

[in] Length

KeyInformation 缓冲区的大小（以字节为单位），调用方必须根据给定的 KeyInformationClass 设置该大小。若要接收所有请求的数据，缓冲区的大小必须至少与请求的数据大小一样大。

[out] ResultLength

结果数据的长度的输出指针。此参数指向调用方分配的 ULONG 变量，该方法在其中写入计数，指定实际写入 KeyInformation 缓冲区的字节数。但是，如果指定的缓冲区长度太小而无法包含信息，则方法会改为输出所需的缓冲区大小，并返回STATUS_BUFFER_OVERFLOW或STATUS_BUFFER_TOO_SMALL。有关更多信息，请参见下面的“备注”部分。

返回值

QueryKey 如果调用成功将请求的信息复制到 KeyInformation 缓冲区，则返回STATUS_SUCCESS。如果指定的缓冲区大小太小，无法接收所有请求的信息，则方法将返回STATUS_BUFFER_OVERFLOW。如果指定的缓冲区大小太小，无法接收任何请求的信息，则方法将返回STATUS_BUFFER_TOO_SMALL。否则，方法将返回相应的错误状态代码。下表显示了一些可能的错误代码。

返回代码	说明
STATUS_INVALID_PARAMETER	指示传递给方法的参数之一无效。

注解

如果 KeyInformation 缓冲区太小而无法保存请求的信息，该方法会将所需大小写入 *ResultLength ，并返回STATUS_BUFFER_OVERFLOW或STATUS_BUFFER_TOO_SMALL的状态代码。如果该方法仅成功将部分请求的信息写入缓冲区，则该方法返回STATUS_BUFFER_OVERFLOW。如果该方法无法将任何信息写入缓冲区，则该方法将返回STATUS_BUFFER_TOO_SMALL。写入 *ResultLength 的值指示保存所有请求信息所需的最小缓冲区大小。