WdfRegistryQueryMemory 函数 (wdfregistry.h)

[适用于 KMDF 和 UMDF]

WdfRegistryQueryMemory 方法检索当前分配给指定注册表值的数据,将数据存储在框架分配的缓冲区中,并创建一个框架内存对象来表示缓冲区。

语法

NTSTATUS WdfRegistryQueryMemory(
  [in]            WDFKEY                 Key,
  [in]            PCUNICODE_STRING       ValueName,
  [in]            POOL_TYPE              PoolType,
  [in, optional]  PWDF_OBJECT_ATTRIBUTES MemoryAttributes,
  [out]           WDFMEMORY              *Memory,
  [out, optional] PULONG                 ValueType
);

参数

[in] Key

表示已打开的注册表项的注册表项对象的句柄。

[in] ValueName

指向包含值名称的 UNICODE_STRING 结构的指针。

[in] PoolType

一个 POOL_TYPE类型化值,指定要为数据缓冲区分配的内存类型。

[in, optional] MemoryAttributes

指向包含新内存对象的对象属性的 WDF_OBJECT_ATTRIBUTES 结构的指针。 此参数是可选的,可以WDF_NO_OBJECT_ATTRIBUTES。

[out] Memory

指向接收新内存对象的句柄的位置的指针。

[out, optional] ValueType

指向接收数据类型的位置的指针。 有关数据类型值的列表,请参阅 KEY_VALUE_BASIC_INFORMATION类型 成员。 此指针是可选的,可以 NULL

返回值

如果作成功,WdfRegistryQueryMemory 将返回STATUS_SUCCESS。 否则,该方法可能会返回以下值之一:

返回代码 说明
STATUS_INVALID_DEVICE_REQUEST

未在 IRQL = PASSIVE_LEVEL 调用 WdfRegistryQueryMemory

STATUS_INVALID_PARAMETER
指定了无效参数。
STATUS_INSUFFICIENT_RESOURCES
无法分配内存对象。
STATUS_ACCESS_DENIED
驱动程序未使用KEY_QUERY_VALUE、KEY_READ或KEY_ALL_ACCESS访问打开注册表项。
STATUS_OBJECT_NAME_NOT_FOUND
注册表值不可用。
STATUS_RESOURCE_DATA_NOT_FOUND
注册表值存在于指定的键下,但为空。
 

有关 WdfRegistryQueryMemory 方法可能返回的其他返回值的列表,请参阅 Framework 对象创建错误

此方法还可以 返回其他NTSTATUS 值。

如果驱动程序提供无效的对象句柄,则会发生 bug 检查。

注解

当驱动程序调用 WdfRegistryQueryMemory时,框架会分配一个足够大的缓冲区来保存指定的注册表值的数据。 WdfRegistryQueryMemory 返回后,驱动程序可以调用 WdfMemoryGetBuffer 以获取指向缓冲区和缓冲区大小的指针。

有关注册表项对象的详细信息,请参阅 使用 Framework-Based 驱动程序中的注册表。

例子

下面的代码示例检索分配给 MyValueName 值的数据,然后获取数据的地址和大小。

WDFMEMORY memory;
size_t size;
PUCHAR pBuf;
NTSTATUS status;
ULONG type;
DECLARE_CONST_UNICODE_STRING(valueName1, L"MyValueName");

status = WdfRegistryQueryMemory(
                                Key,
                                &valueName1,
                                PagedPool,
                                NULL,
                                &memory,
                                &type
                                );
pBuf = (PUCHAR)WdfMemoryGetBuffer(
                                   memory,
                                   &size
                                   );

要求

要求 价值
目标平台 普遍
最低 KMDF 版本 1.0
最低 UMDF 版本 2.0
标头 wdfregistry.h (包括 Wdf.h)
图书馆 Wdf01000.sys(KMDF):WUDFx02000.dll (UMDF)
IRQL PASSIVE_LEVEL
DDI 符合性规则 DriverCreate(kmdf)KmdfIrql(kmdf)KmdfIrql2(kmdf),KmdfIrqlExplicit(kmdf)

另请参阅

KEY_VALUE_BASIC_INFORMATION

POOL_TYPE

UNICODE_STRING

WDF_OBJECT_ATTRIBUTES

WdfMemoryGetBuffer

WdfRegistryQueryMultiString

WdfRegistryQueryString

WdfRegistryQueryULong

WdfRegistryQueryUnicodeString

WdfRegistryQueryValue