WdfCollectionGetFirstItem 函式 (wdfcollection.h)

  • 發行項

[適用於 KMDF 和 UMDF]

WdfCollectionGetFirstItem 方法會傳回物件集合中第一個物件的句柄。

語法

WDFOBJECT WdfCollectionGetFirstItem(
  [in] WDFCOLLECTION Collection
);

參數

[in] Collection

集合物件的句柄。

傳回值

WdfCollectionGetFirstItem 會傳回目前位於指定集合物件清單前端的物件句柄，如果清單是空的，則為 NULL 。

如果驅動程式提供無效的物件句柄，就會發生錯誤檢查。

備註

如需物件集合的詳細資訊，請參閱 Framework 物件集合。

範例

下列程式代碼範例會從集合中移除每個專案，並刪除每個項目的物件。

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

規格需求

需求 值
目標平台 Universal
最小 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)

另請參閱

WdfCollectionGetItem

WdfCollectionGetLastItem