Поделиться через


Функция 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);
}

Требования

Требование Ценность
целевая платформа Всеобщий
минимальная версия KMDF 1.0
минимальная версия UMDF 2.0
заголовка wdfcollection.h (include Wdf.h)
библиотеки Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF)
IRQL <= DISPATCH_LEVEL
правил соответствия DDI DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

См. также

WdfCollectionGetItem

WdfCollectionGetLastItem