WdfChildListBeginScan function (wdfchildlist.h)

Article
02/22/2024

[Applies to KMDF only]

The WdfChildListBeginScan method prepares a specified list of child devices so the driver can update the information in the list.

Syntax

void WdfChildListBeginScan(
  [in] WDFCHILDLIST ChildList
);

Parameters

[in] ChildList

A handle to a framework child list object.

Return value

None

Remarks

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

The WdfChildListBeginScan method marks all of the child devices in the list as missing.

After calling WdfChildListBeginScan, the driver can call WdfChildListAddOrUpdateChildDescriptionAsPresent repeatedly, or call WdfChildListUpdateAllChildDescriptionsAsPresent, to report all of the child devices that are currently attached to the parent device.

After the driver has finished updating the child list, it must call WdfChildListEndScan. This call delivers the updated child list to the Plug and Play (PnP) manager. Subsequently, the framework will call the driver's EvtChildListCreateDevice callback function for each device that the driver reported.

For more information about child lists, see Dynamic Enumeration.

Examples

For a code example that uses WdfChildListBeginScan, see WdfChildListAddOrUpdateChildDescriptionAsPresent.

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)