Функция WdfCollectionGetFirstItem (wdfcollection.h)

  • Статья

[Применимо к KMDF и UMDF]

Метод WdfCollectionGetFirstItem возвращает дескриптор первому объекту, который находится в коллекции объектов.

Синтаксис

WDFOBJECT WdfCollectionGetFirstItem(
  [in] WDFCOLLECTION Collection
);

Параметры

[in] Collection

Дескриптор объекта коллекции.

Возвращаемое значение

WdfCollectionGetFirstItem возвращает дескриптор объекта, который в настоящее время находится в начале списка объектов указанной коллекции, или значение NULL , если список пуст.

Ошибка проверка возникает, если драйвер предоставляет недопустимый дескриптор объекта.

Комментарии

Дополнительные сведения о коллекциях объектов см. в разделе Коллекции объектов платформы.

Примеры

В следующем примере кода удаляется каждый элемент из коллекции и удаляется объект каждого элемента.

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

Требования

Требование Значение
Целевая платформа Универсальное
Минимальная версия 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