WdfRegistryCreateKey 函数 (wdfregistry.h)

[适用于 KMDF 和 UMDF]

WdfRegistryCreateKey 方法创建并打开指定的注册表项,或者仅打开该注册表项(如果已存在),并创建表示注册表项的框架注册表项对象。

语法

NTSTATUS WdfRegistryCreateKey(
  [in, optional]  WDFKEY                 ParentKey,
  [in]            PCUNICODE_STRING       KeyName,
  [in]            ACCESS_MASK            DesiredAccess,
  [in]            ULONG                  CreateOptions,
  [out, optional] PULONG                 CreateDisposition,
  [in, optional]  PWDF_OBJECT_ATTRIBUTES KeyAttributes,
  [out]           WDFKEY                 *Key
);

参数

[in, optional] ParentKey

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

[in] KeyName

指向包含要打开的键名称 的UNICODE_STRING 结构的指针。 密钥名称可以包含路径信息。 如果 ParentKeyNULL则 KeyName 必须指定注册表项的完整路径。

[in] DesiredAccess

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

[in] CreateOptions

一个或多个标志。 有关这些标志的信息,请参阅 CreateOptions 参数或 ZwCreateKey

[out, optional] CreateDisposition

指向位置的指针,该位置在创建新密钥时接收REG_CREATED_NEW_KEY;如果打开现有密钥,则REG_OPENED_EXISTING_KEY。 这些值在 Wdm.h 中定义。 此指针是可选的,可以为 NULL

[in, optional] KeyAttributes

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

[out] Key

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

返回值

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

返回代码 说明
STATUS_INVALID_DEVICE_REQUEST

未在 IRQL = PASSIVE_LEVEL调用 WdfRegistryCreateKey

STATUS_INVALID_PARAMETER
指定的参数无效。
STATUS_INSUFFICIENT_RESOURCES
无法分配注册表项对象。
STATUS_ACCESS_DENIED
系统拒绝了指定的访问权限。
STATUS_OBJECT_NAME_NOT_FOUND
指定的注册表项不存在。
 

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

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

注解

若要获取表示父键的注册表项对象的句柄,驱动程序可以调用 WdfDriverOpenParametersRegistryKeyWdfDeviceOpenRegistryKeyWdfFdoInitOpenRegistryKey

默认情况下,新注册表项对象的父级是 WdfDriverCreate 方法创建的框架驱动程序对象。 可以使用 WDF_OBJECT_ATTRIBUTES 结构的 ParentObject 成员来指定不同的父级。 框架在删除父对象时删除注册表项对象。 如果驱动程序未更改默认父级,则驱动程序应在完成使用 对象后删除注册表项对象;否则,注册表项对象将一直保留,直到 I/O 管理器卸载驱动程序。

如果驱动程序未更改默认父级,则驱动程序应在使用 完 对象后调用 WdfRegistryClose ;否则,注册表项对象将一直保留,直到 I/O 管理器卸载驱动程序。 或者,驱动程序可以调用 WdfObjectDelete 来删除注册表项对象。

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

示例

下面的代码示例打开驱动程序的软件密钥,然后创建并打开位于驱动程序的软件密钥下的 myKeyStr 注册表项。

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"myKeyStr"
                         );
    status = WdfRegistryCreateKey(
                                  hKey,
                                  &myKeyStr,
                                  KEY_READ,
                                  REG_OPTION_NON_VOLATILE,
                                  NULL,
                                  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)

另请参阅

ACCESS_MASK

RtlInitUnicodeString

UNICODE_STRING

WDF_OBJECT_ATTRIBUTES

WdfDeviceOpenRegistryKey

WdfDriverCreate

WdfDriverOpenParametersRegistryKey

WdfFdoInitOpenRegistryKey

WdfRegistryOpenKey

ZwCreateKey