WdfCollectionGetFirstItem-Funktion (wdfcollection.h)
[Gilt für KMDF und UMDF]
Die WdfCollectionGetFirstItem-Methode gibt ein Handle an das erste Objekt zurück, das sich in einer Objektauflistung befindet.
Syntax
WDFOBJECT WdfCollectionGetFirstItem(
[in] WDFCOLLECTION Collection
);
Parameter
[in] Collection
Ein Handle für ein Auflistungsobjekt.
Rückgabewert
WdfCollectionGetFirstItem gibt ein Handle an das Objekt zurück, das sich derzeit an der Vorderseite der Liste der Objekte der angegebenen Auflistung befindet, oder NULL , wenn die Liste leer ist.
Eine Fehlerüberprüfung tritt auf, wenn der Treiber ein ungültiges Objekthandle bereitstellt.
Hinweise
Weitere Informationen zu Objektsammlungen finden Sie unter Framework-Objektsammlungen.
Beispiele
Im folgenden Codebeispiel wird jedes Element aus einer Auflistung entfernt und das Objekt jedes Elements gelöscht.
while ((subRequest = WdfCollectionGetFirstItem(hCollection)) != NULL) {
WdfCollectionRemoveItem(
hCollection,
0
);
WdfObjectDelete(subRequest);
}
Anforderungen
| Anforderung | Wert |
|---|---|
| Zielplattform | Universell |
| KMDF-Mindestversion | 1.0 |
| UMDF-Mindestversion | 2.0 |
| Kopfzeile | wdfcollection.h (einschließen von Wdf.h) |
| Bibliothek | Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF) |
| IRQL | <= DISPATCH_LEVEL |
| DDI-Complianceregeln | DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf) |