WdfRegistryAssignString 函数 (wdfregistry.h)

项目
02/29/2024

[适用于 KMDF 和 UMDF]

WdfRegistryAssignString 方法将字符串分配给注册表中的指定值名称。字符串包含在指定的框架字符串对象中。

语法

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

参数

[in] Key

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

[in] ValueName

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

[in] String

包含字符串的框架字符串对象的句柄。

返回值

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

返回代码	说明
STATUS_INVALID_DEVICE_REQUEST	未在 IRQL = PASSIVE_LEVEL调用 WdfRegistryAssignString。
STATUS_INVALID_PARAMETER	指定的参数无效。
STATUS_ACCESS_DENIED	驱动程序未打开具有KEY_SET_VALUE访问权限的注册表项。

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

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

注解

如果 ValueName 参数指定的值名称已存在， 则 WdfRegistryAssignString 会更新该值的数据。

框架将值的数据类型设置为REG_SZ。

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

示例

下面的代码示例创建一个包含字符串“String1”的字符串对象，并将该字符串分配给指定的注册表项下的 ValueName 值。

WDFSTRING string1;
UNICODE_STRING ustring1, valueName;
NTSTATUS status;

RtlInitUnicodeString(
                     &ustring1,
                     L"String1"
                     );
RtlInitUnicodeString(
                     &valueName,
                     L"ValueName"
                     );

status = WdfStringCreate(
                         &ustring1,
                         WDF_NO_OBJECT_ATTRIBUTES,
                         &string1
                         );
if (NT_SUCCESS(status)) {
    status = WdfRegistryAssignString(
                                     Key,
                                     &valueName,
                                     string1
                                     );
}

要求

要求	值
目标平台	通用
最低 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)