WdfFdoGetDefaultChildList function (wdffdo.h)

[Applies to KMDF only]

The WdfFdoGetDefaultChildList method returns a handle to a specified device's default child list.

Syntax

WDFCHILDLIST WdfFdoGetDefaultChildList(
  [in] WDFDEVICE Fdo
);

Parameters

[in] Fdo

A handle to a framework device object.

Return value

If the operation succeeds, WdfFdoGetDefaultChildList returns a handle to the default child list that is associated with the device that is specified by Fdo. Otherwise the method returns NULL.

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

Remarks

Before calling WdfFdoGetDefaultChildList, your driver must call WdfFdoInitSetDefaultChildListConfig to configure the default child list. Otherwise, WdfFdoGetDefaultChildList returns NULL.

For more information about child lists, see Dynamic Enumeration.

Examples

The following code example obtains a handle to a device's default child list.

WDFCHILDLIST  list;

list = WdfFdoGetDefaultChildList(Device);

Requirements

Requirement Value
Target Platform Universal
Minimum KMDF version 1.0
Header wdffdo.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)

See also

WdfFdoInitSetDefaultChildListConfig