WdfCollectionGetFirstItem 函数 (wdfcollection.h)

  • 项目

[适用于 KMDF 和 UMDF]

WdfCollectionGetFirstItem 方法返回对象集合中第一个对象的句柄。

语法

WDFOBJECT WdfCollectionGetFirstItem(
  [in] WDFCOLLECTION Collection
);

参数

[in] Collection

集合对象的句柄。

返回值

WdfCollectionGetFirstItem 返回当前位于指定集合对象列表前面的对象的句柄;如果列表为空，则返回 NULL 。

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

注解

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

示例

下面的代码示例从集合中删除每个项，并删除每个项的 对象。

while ((subRequest = WdfCollectionGetFirstItem(hCollection)) != NULL) {
    WdfCollectionRemoveItem(
                            hCollection,
                            0
                            );
    WdfObjectDelete(subRequest);
}

要求

要求 值
目标平台 通用
最低 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)

另请参阅

WdfCollectionGetItem

WdfCollectionGetLastItem