WdfChildListEndIteration function (wdfchildlist.h)

Article
02/22/2024

[Applies to KMDF only]

The WdfChildListEndIteration method processes modifications to a specified child list.

Syntax

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

Parameters

[in] ChildList

The same handle to a framework child-list object that the driver previously specified to WdfChildListBeginIteration.

[in] Iterator

A pointer to the same caller-allocated WDF_CHILD_LIST_ITERATOR structure that the driver previously supplied to WdfChildListEndIteration.

Return value

None

Remarks

A bug check occurs if the driver supplies an invalid object handle.

If the driver has made multiple calls to WdfChildListBeginIteration or WdfChildListBeginScan, the framework does not process modifications to the child list until the driver has made a corresponding number of calls to WdfChildListEndIteration and WdfChildListEndScan.

For more information about child lists, see Dynamic Enumeration.

Examples

For a code example that uses WdfChildListEndIteration, see WdfChildListRetrieveNextDevice.

Requirements

Requirement	Value
Target Platform	Universal
Minimum KMDF version	1.0
Header	wdfchildlist.h (include Wdf.h)
Library	Wdf01000.sys (see Framework Library Versioning.)
IRQL	<= DISPATCH_LEVEL
DDI compliance rules	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

Share via