WdfChildListBeginIteration-Funktion (wdfchildlist.h)

[Gilt nur für KMDF]

Die WdfChildListBeginIteration-Methode bereitet das Framework für das Abrufen von Elementen aus einer angegebenen untergeordneten Liste vor.

Syntax

void WdfChildListBeginIteration(
  [in] WDFCHILDLIST             ChildList,
  [in] PWDF_CHILD_LIST_ITERATOR Iterator
);

Parameter

[in] ChildList

Ein Handle für ein untergeordnetes Frameworklistenobjekt.

[in] Iterator

Ein Zeiger auf eine vom Aufrufer zugewiesene WDF_CHILD_LIST_ITERATOR Struktur, die den Typ der abzurufenden untergeordneten Geräte angibt.

Rückgabewert

Keine

Bemerkungen

Eine Fehlerüberprüfung tritt auf, wenn der Treiber ein ungültiges Objekthandle bereitstellt.

Nach dem Aufruf von WdfChildListBeginIteration kann der Treiber WdfChildListRetrieveNextDevice wiederholt aufrufen, um Informationen zu jedem untergeordneten Gerät in der untergeordneten Liste abzurufen.

Nachdem der Treiber den Aufruf von WdfChildListRetrieveNextDevice abgeschlossen hat, muss er WdfChildListEndIteration aufrufen.

Wenn der Treiber nach dem Aufruf von WdfChildListBeginIteration Änderungen an der untergeordneten Liste vornimmt, speichert das Framework alle Änderungen und benachrichtigt den PnP-Manager (Plug & Play) über die Änderungen, wenn der Treiber WdfChildListEndIteration aufruft.

Der Treiber kann Aufrufe von WdfChildListBeginIteration und WdfChildListEndIteration schachteln. Wenn der Treiber Aufrufe dieser Methoden verschachtelt, speichert das Framework alle Änderungen bis zum letzten Aufruf von WdfChildListEndIteration.

Weitere Informationen zu untergeordneten Listen finden Sie unter Dynamische Enumeration.

Beispiele

Ein Codebeispiel, das WdfChildListBeginIteration verwendet, finden Sie unter WdfChildListRetrieveNextDevice.

Anforderungen

Anforderung Wert
Zielplattform Universell
KMDF-Mindestversion 1.0
Kopfzeile wdfchildlist.h (einschließen von Wdf.h)
Bibliothek Wdf01000.sys (siehe Versionierung der Frameworkbibliothek.)
IRQL <= DISPATCH_LEVEL
DDI-Complianceregeln DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

Weitere Informationen

WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER_INIT

WDF_CHILD_LIST_ITERATOR

WDF_CHILD_LIST_ITERATOR_INIT

WdfChildListBeginScan

WdfChildListEndIteration

WdfChildListRequestChildEject

WdfChildListRetrieveNextDevice