WdfChildListCreate 函数 (wdfchildlist.h)

  • 项目

[仅适用于 KMDF]

WdfChildListCreate 方法为指定的父设备创建子列表。

语法

NTSTATUS WdfChildListCreate(
  [in]           WDFDEVICE              Device,
  [in]           PWDF_CHILD_LIST_CONFIG Config,
  [in, optional] PWDF_OBJECT_ATTRIBUTES ChildListAttributes,
  [out]          WDFCHILDLIST           *ChildList
);

参数

[in] Device

表示父设备的框架设备对象的句柄。

[in] Config

指向 WDF_CHILD_LIST_CONFIG 结构的指针，该结构包含驱动程序为子列表提供的配置信息。

[in, optional] ChildListAttributes

指向 WDF_OBJECT_ATTRIBUTES 结构的指针，该结构包含框架子列表对象的驱动程序提供的对象属性。 (结构的 ParentObject 成员必须为 NULL.)

[out] ChildList

指向调用方分配的位置的指针，该位置接收框架子列表对象的句柄。

返回值

如果操作成功，WdfChildListCreate 返回STATUS_SUCCESS或NT_SUCCESS (状态) 等于 TRUE 的另一个状态值。 否则，此方法可能会返回以下值之一：

返回代码 说明
STATUS_INVALID_PARAMETER
 输入参数无效。
STATUS_INSUFFICIENT_RESOURCES
 无法分配对象。
 

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

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

注解

框架为每个框架设备对象创建一个默认子列表，该对象表示 FDO) (功能设备对象。 若要使用默认子列表，驱动程序会调用 WdfFdoGetDefaultChildList。 如果驱动程序需要其他子列表，它可以调用 WdfChildListCreate 来创建它们。

每个子列表对象的父级是设备的框架设备对象。 驱动程序无法更改此父级， 并且 ParentObject 成员或 WDF_OBJECT_ATTRIBUTES 结构必须为 NULL。

驱动程序无法删除 WdfChildListCreate 创建的子列表对象。 框架在适当的时间删除对象。

有关子列表的详细信息，请参阅 动态枚举。

示例

下面的代码示例初始化 WDF_CHILD_LIST_CONFIG 结构，然后调用 WdfChildListCreate。

WDF_CHILD_LIST_CONFIG listConfig;

WDF_CHILD_LIST_CONFIG_INIT(
                           &listConfig,
                           sizeof(PDO_IDENTIFICATION_DESCRIPTION),
                           My_EvtDeviceListCreatePdo
                           );

listConfig.AddressDescriptionSize = sizeof(PDO_ADDRESS_DESCRIPTION);

listConfig.EvtChildListScanForChildren = My_EvtChildListScanForChildren;

listConfig.EvtChildListIdentificationDescriptionDuplicate = My_EvtChildListIdentificationDescriptionDuplicate;
listConfig.EvtChildListIdentificationDescriptionCompare = My_EvtChildListIdentificationDescriptionCompare;
listConfig.EvtChildListIdentificationDescriptionCleanup = My_EvtChildListIdentificationDescriptionCleanup;

status = WdfChildListCreate(
                            device,
                            &listConfig,
                            WDF_NO_OBJECT_ATTRIBUTES,
                            &ParentDeviceContext->ChildList
                            );
if (!NT_SUCCESS(status)) {
    return status;
}

要求

要求 值
目标平台 通用
最低 KMDF 版本 1.0
标头 wdfchildlist.h (包括 Wdf.h)
Library Wdf01000.sys (请参阅框架库 Versioning.)
IRQL PASSIVE_LEVEL
DDI 符合性规则 DriverCreate (kmdf) 、 KmdfIrql (kmdf) 、 KmdfIrql2 (kmdf) 、 KmdfIrqlExplicit (kmdf)

另请参阅

WDF_CHILD_LIST_CONFIG

WDF_CHILD_LIST_CONFIG_INIT

WdfFdoGetDefaultChildList