WdfFdoInitOpenRegistryKey 函数 (wdffdo.h)

[适用于 KMDF 和 UMDF]

WdfFdoInitOpenRegistryKey 方法在注册表中打开设备的硬件密钥或驱动程序的软件密钥,并创建表示注册表项的框架注册表项对象。

语法

NTSTATUS WdfFdoInitOpenRegistryKey(
  [in]           PWDFDEVICE_INIT        DeviceInit,
  [in]           ULONG                  DeviceInstanceKeyType,
  [in]           ACCESS_MASK            DesiredAccess,
  [in, optional] PWDF_OBJECT_ATTRIBUTES KeyAttributes,
  [out]          WDFKEY                 *Key
);

参数

[in] DeviceInit

指向驱动程序从其 EvtDriverDeviceAdd 回调函数获取的WDFDEVICE_INIT结构的指针。

[in] DeviceInstanceKeyType

指定要打开的键或子项。

注意

UMDF 不支持创建子项。

这是以下标志的按位 OR, (在 Wdm.h) 中定义。

DeviceInstanceKeyType 标志 含义 框架
PLUGPLAY_REGKEY_DEVICE 打开设备的硬件密钥。 KMDF/UMDF
PLUGPLAY_REGKEY_DRIVER 打开驱动程序的软件密钥。 设置此标志的 UMDF 驱动程序还必须将 DesiredAccess 设置为 KEY_READ。 否则此方法返回 STATUS_ACCESS_DENIED KMDF/UMDF
PLUGPLAY_REGKEY_CURRENT_HWPROFILE KMDF 驱动程序使用此标志打开当前硬件配置文件中的硬件或软件密钥的副本。 KMDF
PLUGPLAY_REGKEY_DRIVER |WDF_REGKEY_DRIVER_SUBKEY UMDF 驱动程序将这些标志一起使用,以打开驱动程序软件密钥的 ServiceName 子项进行读/写访问。 UMDF
PLUGPLAY_REGKEY_DEVICE |WDF_REGKEY_DEVICE_SUBKEY 同样,UMDF 驱动程序使用这些标志打开设备的硬件密钥的 ServiceName 子项进行读/写访问。 UMDF

[in] DesiredAccess

一个ACCESS_MASK类型的值,该值指定驱动程序为指定的注册表项请求的访问权限。

KMDF 驱动程序通常请求 KEY_READKEY_WRITEKEY_READ |KEY_WRITE

如果要编写 UMDF 驱动程序,请使用下表。

DeviceInstanceKeyType DesiredAccess
PLUGPLAY_REGKEY_DEVICE KEY_READ
PLUGPLAY_REGKEY_DEVICE |WDF_REGKEY_DEVICE_SUBKEY KEY_READKEY_READ |KEY_SET_VALUE
PLUGPLAY_REGKEY_DRIVER KEY_READ
PLUGPLAY_REGKEY_DRIVER |WDF_REGKEY_DRIVER_SUBKEY KEY_READKEY_READ |KEY_SET_VALUE
 

最佳做法是,只要求驱动程序所需的访问类型。

[in, optional] KeyAttributes

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

[out] Key

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

返回值

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

返回代码 说明
STATUS_INVALID_DEVICE_REQUEST

WdfFdoInitOpenRegistryKey 未在 IRQL = PASSIVE_LEVEL调用。

STATUS_INVALID_PARAMETER
指定了无效参数,或者驱动程序未从其 EvtDriverDeviceAdd 回调函数获取WDFDEVICE_INIT结构。 对于 UMDF,此返回值可能指示访问权限不足。
STATUS_INSUFFICIENT_RESOURCES
无法分配注册表项对象。
STATUS_OBJECT_NAME_NOT_FOUND
指定的注册表项不存在。
 

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

该方法还可以返回其他 NTSTATUS 值

注解

驱动程序必须在调用 WdfDeviceCreate 之前调用 WdfFdoInitOpenRegistryKey。 有关调用 WdfDeviceCreate 的详细信息,请参阅 创建框架设备对象

有关 WdfFdoInitOpenRegistryKey 方法的详细信息,请参阅 在函数驱动程序中创建设备对象

或有关注册表、硬件和软件密钥和注册表对象的详细信息,请参阅 在Framework-Based驱动程序中使用注册表

示例

下面的代码示例打开设备的硬件密钥,并具有读取访问权限。

WDFKEY key;
NTSTATUS status;

status = WdfFdoInitOpenRegistryKey(
                                   DeviceInit,
                                   PLUGPLAY_REGKEY_DEVICE,
                                   GENERIC_READ,
                                   WDF_NO_OBJECT_ATTRIBUTES,
                                   &key
                                   );
if (!NT_SUCCESS(status)) {
    return status;
}

要求

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

请参阅

WdfDeviceOpenRegistryKey

WdfDriverOpenParametersRegistryKey