WdfCollectionCreate 函数 (wdfcollection.h)

  • 项目

[适用于 KMDF 和 UMDF]

WdfCollectionCreate 方法创建框架集合对象。

语法

NTSTATUS WdfCollectionCreate(
  [in, optional] PWDF_OBJECT_ATTRIBUTES CollectionAttributes,
  [out]          WDFCOLLECTION          *Collection
);

参数

[in, optional] CollectionAttributes

指向调用方分配 的WDF_OBJECT_ATTRIBUTES 结构的指针，该结构包含新集合对象的属性。 此参数是可选的，可以WDF_NO_OBJECT_ATTRIBUTES。

[out] Collection

指向接收新集合对象的句柄的位置的指针。

返回值

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

返回代码 说明
STATUS_INVALID_PARAMETER
 调用方提供的参数值无效。
STATUS_INSUFFICIENT_RESOURCES
 无法分配集合对象。
 

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

注解

调用 WdfCollectionCreate 以创建框架集合对象后，驱动程序可以调用 WdfCollectionAdd 将对象添加到集合。

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

有关对象集合的详细信息，请参阅 框架对象集合。

示例

有关使用 WdfCollectionCreate 的代码示例，请参阅 WdfCollectionAdd。

要求

要求 值
目标平台 通用
最低 KMDF 版本 1.0
最低 UMDF 版本 2.0
标头 wdfcollection.h (包括 Wdf.h)
Library Wdf01000.sys (KMDF) ;WUDFx02000.dll (UMDF)
IRQL <= DISPATCH_LEVEL
DDI 符合性规则 DriverCreate (kmdf) 、 KmdfIrql (kmdf) 、 KmdfIrql2 (kmdf) 、 KmdfIrqlExplicit (kmdf)

另请参阅

WDF_OBJECT_ATTRIBUTES

WdfCollectionAdd

WdfCollectionRemove

WdfDriverCreate