WdfCollectionGetItem-Funktion (wdfcollection.h)
[Gilt für KMDF und UMDF]
Die WdfCollectionGetItem- -Methode gibt ein Handle an das Objekt zurück, das in einer angegebenen Objektauflistung enthalten ist und einem angegebenen Indexwert zugeordnet ist.
Syntax
WDFOBJECT WdfCollectionGetItem(
[in] WDFCOLLECTION Collection,
[in] ULONG Index
);
Parameter
[in] Collection
Ein Handle zu einem Auflistungsobjekt.
[in] Index
Ein nullbasierter Indexwert, der ein Objekt in der Auflistung identifiziert.
Rückgabewert
WdfCollectionGetItem- gibt ein Frameworkobjekthandle zurück oder NULL-, wenn der Index- Wert ungültig ist.
Eine Systemfehlerüberprüfung tritt auf, wenn der Treiber ein ungültiges Objekthandle bereitstellt.
Bemerkungen
Indexwerte stellen die Reihenfolge dar, in der Objekte einer Auflistung hinzugefügt werden. Ein Indexwert von Null stellt das erste Objekt in der Auflistung dar, ein Indexwert von 1 stellt das zweite Objekt dar usw. wie eine verknüpfte Liste. Wenn der Treiber das Element i aus einer Sammlung entfernt, wird element i+1 element i.
Weitere Informationen zu Objektsammlungen finden Sie unter Framework-Objektsammlungen.
Beispiele
Ein Codebeispiel, das WdfCollectionGetItem-verwendet, finden Sie unter WdfCollectionGetCount.
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) |