WdfRegistryOpenKey 函数 (wdfregistry.h)

项目
08/08/2023

[适用于 KMDF 和 UMDF]

WdfRegistryOpenKey 方法打开指定的注册表项，并创建表示该注册表项的框架注册表项对象。

语法

NTSTATUS WdfRegistryOpenKey(
  [in, optional] WDFKEY                 ParentKey,
  [in]           PCUNICODE_STRING       KeyName,
  [in]           ACCESS_MASK            DesiredAccess,
  [in, optional] PWDF_OBJECT_ATTRIBUTES KeyAttributes,
  [out]          WDFKEY                 *Key
);

参数

[in, optional] ParentKey

框架注册表项对象的句柄。此对象表示驱动程序已打开的父注册表项。此参数是可选的，可以为 NULL。如果参数不为 NULL，则 KeyName 指定的项必须位于注册表中的此父项下。有关此父密钥的详细信息，请参阅“备注”部分。

[in] KeyName

指向包含要打开的项名称的UNICODE_STRING 结构的指针。密钥名称可以包含路径信息。如果 ParentKey 为 NULL， 则 KeyName 必须指定注册表项的完整路径。有关示例，请参阅“备注”部分。

[in] DesiredAccess

一个ACCESS_MASK类型的值，该值指定驱动程序为指定注册表项请求的访问权限。有关驱动程序通常用于注册表项的访问权限列表，请参阅打开 Registry-Key 对象的句柄。驱动程序必须仅请求所需的访问类型。例如，如果驱动程序仅读取注册表项，则不得请求KEY_ALL_ACCESS。

[in, optional] KeyAttributes

指向 WDF_OBJECT_ATTRIBUTES 结构的指针，该结构包含驱动程序为新的注册表项对象提供的属性。此参数是可选的，可以WDF_NO_OBJECT_ATTRIBUTES。

[out] Key

指向接收新注册表项对象的句柄的位置的指针。

返回值

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

返回代码	说明
STATUS_INVALID_DEVICE_REQUEST	未在 IRQL = PASSIVE_LEVEL调用 WdfRegistryOpenKey。
STATUS_INVALID_PARAMETER	指定的参数无效。
STATUS_INSUFFICIENT_RESOURCES	无法分配注册表项对象。
STATUS_ACCESS_DENIED	系统拒绝了指定的访问权限。
STATUS_OBJECT_NAME_NOT_FOUND	指定的注册表项不存在。

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

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

注解

若要获取表示父键的注册表项对象的句柄，驱动程序可以调用 WdfDriverOpenParametersRegistryKey、 WdfDeviceOpenRegistryKey 或 WdfFdoInitOpenRegistryKey。

KeyName 参数中指定的字符串格式取决于调用方是 KMDF 驱动程序还是 UMDF 驱动程序。例如，打开以下路径：

HKLM\System\CurrentControlSet\Control

驱动程序可能使用此条件逻辑：

#ifdef _KERNEL_MODE
#define CONTROL_KEY_FULL_PATH L"\\Registry\\Machine\\System\\CurrentControlSet\\Control "
#else
#define CONTROL_KEY_FULL_PATH L"System\\CurrentControlSet\\Control\\" 
#endif

驱动程序使用完使用 WdfRegistryOpenKey 打开的注册表项后，驱动程序必须调用 WdfRegistryClose。

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

示例

下面的代码示例打开驱动程序的软件密钥，然后打开 MySubKey 注册表项，该注册表项位于驱动程序的软件密钥下。

WDFKEY  hKey, subkey;
NTSTATUS  status;
UNICODE_STRING myKeyStr;

status = WdfDeviceOpenRegistryKey(
                                  device,
                                  PLUGPLAY_REGKEY_DRIVER,
                                  KEY_READ,
                                  WDF_NO_OBJECT_ATTRIBUTES,
                                  &hKey
                                  );
if (NT_SUCCESS(status)){
    RtlInitUnicodeString(
                         &myKeyStr,
                         L"MySubKey"
                         );
    status = WdfRegistryOpenKey(
                                hKey,
                                &myKeyStr,
                                KEY_READ,
                                WDF_NO_OBJECT_ATTRIBUTES,
                                &subkey
                                );
}

要求

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