WdfCollectionGetFirstItem - NtDoc
Native API online documentation, based on the System Informer
(formerly Process Hacker) phnt
headers
// wdfcollection.h
WDFOBJECT WdfCollectionGetFirstItem(
[in] WDFCOLLECTION Collection
);
View the official Windows Driver Kit DDI referenceNo description available.
[Applies to KMDF and UMDF]
The WdfCollectionGetFirstItem method returns a handle to the first object that is in an object collection.
Collection [in]A handle to a collection object.
WdfCollectionGetFirstItem returns a handle to the object that is currently at the front of the specified collection's list of objects, or NULL if the list is empty.
A bug check occurs if the driver supplies an invalid object handle.
For more information about object collections, see Framework Object Collections.
The following code example removes each item from a collection and deletes each item's object.
while ((subRequest = WdfCollectionGetFirstItem(hCollection)) != NULL) {
WdfCollectionRemoveItem(
hCollection,
0
);
WdfObjectDelete(subRequest);
}