WdfRegistryQueryUnicodeString 函数 (wdfregistry.h)

项目
08/08/2023

[适用于 KMDF 和 UMDF]

WdfRegistryQueryUnicodeString 方法检索当前分配给指定注册表字符串值的字符串数据，并将字符串复制到指定的UNICODE_STRING结构。

语法

NTSTATUS WdfRegistryQueryUnicodeString(
  [in]            WDFKEY           Key,
  [in]            PCUNICODE_STRING ValueName,
  [out, optional] PUSHORT          ValueByteLength,
  [in, out]       PUNICODE_STRING  Value
);

参数

[in] Key

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

[in] ValueName

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

[out, optional] ValueByteLength

指向位置的指针，该位置接收 Value 指向的 Unicode 字符串中包含的字节数，包括 终止 NULL 字节 。此指针是可选的，可以为 NULL

[in, out] Value

指向UNICODE_STRING 结构的指针，该结构接收 Key 指定的键的数据字符串。如果此参数为 NULL 且 ValueByteLength 为非 NULL， 则 WdfRegistryQueryUnicodeString 仅返回字符串的大小。

返回值

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

返回代码	说明
STATUS_INVALID_DEVICE_REQUEST	未在 IRQL = PASSIVE_LEVEL调用 WdfRegistryQueryUnicodeString。
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_BUFFER_OVERFLOW	Value 参数指向的缓冲区太小，只将部分数据写入缓冲区。
STATUS_BUFFER_OVERFLOW	Value 参数指向的缓冲区太小，没有将数据写入缓冲区。
STATUS_OBJECT_NAME_NOT_FOUND	注册表值不可用。

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

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

注解

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

示例

以下代码示例（来自串行示例驱动程序）检索 Unicode 字符串，该字符串表示分配给设备硬件密钥下的 PortName 值的字符串数据。

NTSTATUS
SerialReadSymName(
    IN WDFDEVICE Device,
    __out PWCHAR RegName,
    IN OUT PUSHORT LengthOfRegName // In characters
    )
{
    NTSTATUS status;
    WDFKEY hKey;
    UNICODE_STRING value;
    UNICODE_STRING valueName;
    USHORT requiredLength;

    value.Buffer = RegName;
    value.MaximumLength = *LengthOfRegName;
    value.Length = 0;

    status = WdfDeviceOpenRegistryKey(
                                      Device,
                                      PLUGPLAY_REGKEY_DEVICE,
                                      STANDARD_RIGHTS_ALL,
                                      WDF_NO_OBJECT_ATTRIBUTES,
                                      &hKey
                                      );

    if (NT_SUCCESS (status)) {
        RtlInitUnicodeString(
                             &valueName,
                             L"PortName"
                             );
        status = WdfRegistryQueryUnicodeString (
                                      hKey,
                                      &valueName,
                                      &requiredLength,
                                      &value
                                      );
        WdfRegistryClose(hKey);
    }
    return status;
}

要求

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