WdfRegistryQueryString 函数 (wdfregistry.h)

项目
08/08/2023

[适用于 KMDF 和 UMDF]

WdfRegistryQueryString 方法检索当前分配给指定注册表字符串值的字符串数据，并将字符串分配给指定的框架字符串对象。

语法

NTSTATUS WdfRegistryQueryString(
  [in] WDFKEY           Key,
  [in] PCUNICODE_STRING ValueName,
  [in] WDFSTRING        String
);

参数

[in] Key

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

[in] ValueName

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

[in] String

框架字符串对象的句柄。框架会将注册表值的字符串数据分配给此对象。

返回值

如果操作成功，WdfRegistryQueryString 将返回STATUS_SUCCESS。否则，该方法可能会返回以下值之一：

返回代码	说明
STATUS_INVALID_DEVICE_REQUEST	未在 IRQL = PASSIVE_LEVEL调用 WdfRegistryQueryString。
STATUS_INVALID_PARAMETER	指定的参数无效。
STATUS_INSUFFICIENT_RESOURCES	内存不足，无法完成操作。
STATUS_ACCESS_DENIED	驱动程序未使用KEY_QUERY_VALUE、KEY_READ或KEY_ALL_ACCESS访问权限打开注册表项。
STATUS_OBJECT_TYPE_MISMATCH	指定的 ValueName 参数未REG_SZ注册表值的数据类型。
STATUS_OBJECT_NAME_NOT_FOUND	注册表值不可用。
STATUS_RESOURCE_DATA_NOT_FOUND	注册表值存在于指定的项下，但为空。

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

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

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

注解

若要从字符串对象获取字符串，驱动程序可以调用 WdfStringGetUnicodeString。

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

示例

下面的代码示例创建一个字符串对象，从注册表项检索字符串数据，并从字符串对象获取字符串数据。

UNICODE_STRING str;
WDFSTRING string;
NTSTATUS status;
DECLARE_CONST_UNICODE_STRING(valueName, STRING_VALUE_NAME);

status = WdfStringCreate(
                         NULL,
                         WDF_NO_OBJECT_ATTRIBUTES,
                         &string
                         );
if (NT_SUCCESS(status)) {
    status = WdfRegistryQueryString(
                                    Key, 
                                    &valueName,
                                    string
                                    );
    if (NT_SUCCESS(status)) {
        WdfStringGetUnicodeString(
                                  string,
                                  &str
                                  );
    }
}

要求

要求	值
目标平台	通用
最低 KMDF 版本	1.0
最低 UMDF 版本	2.0
标头	wdfregistry.h (包括 Wdf.h)
Library	Wdf01000.sys (KMDF) ;WUDFx02000.dll (UMDF)
IRQL	PASSIVE_LEVEL
DDI 符合性规则	DriverCreate (kmdf) 、 KmdfIrql (kmdf) 、 KmdfIrql2 (kmdf) 、 KmdfIrqlExplicit (kmdf)