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。 否则,此方法可能会返回以下值之一:
返回代码 | 描述 |
---|---|
|
调用方提供了无效的参数值。 |
|
无法分配集合对象。 |
此方法也可能返回其他 NTSTATUS 值。
言论
调用 WdfCollectionCreate 以创建框架集合对象后,驱动程序可以调用 WdfCollectionAdd 将对象添加到集合中。
默认情况下,新集合对象的父对象是 WdfDriverCreate 方法创建的框架驱动程序对象。 可以使用 WDF_OBJECT_ATTRIBUTES 结构的 ParentObject 成员来指定不同的父级。 框架在删除父对象时删除集合对象。 如果驱动程序未更改默认父级,则驱动程序在使用完该对象后应删除集合对象;否则,对象将一直保留,直到 I/O 管理器卸载驱动程序。
有关对象集合的详细信息,请参阅 Framework 对象集合。
例子
有关使用 WdfCollectionCreate的代码示例,请参阅 WdfCollectionAdd。
要求
要求 | 价值 |
---|---|
目标平台 | 普遍 |
最低 KMDF 版本 | 1.0 |
最低 UMDF 版本 | 2.0 |
标头 | wdfcollection.h (包括 Wdf.h) |
库 | Wdf01000.sys(KMDF):WUDFx02000.dll (UMDF) |
IRQL | <= DISPATCH_LEVEL |
DDI 符合性规则 | DriverCreate(kmdf),KmdfIrql(kmdf),KmdfIrql2(kmdf),KmdfIrqlExplicit(kmdf) |