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 zu einem 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.
Wenn der Treiber ein ungültiges Objekthandle bereitstellt, tritt eine Fehlerüberprüfung auf.
Bemerkungen
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- | Universal |
| Minimale KMDF-Version | 1.0 |
| Mindest-UMDF-Version | 2.0 |
| Header- | wdfcollection.h (include Wdf.h) |
| Library | Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF) |
| IRQL- | <= DISPATCH_LEVEL |
| DDI-Complianceregeln | DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf) |