WDF_RETRIEVE_CHILD_FLAGS enumeration (wdfchildlist.h)

[Applies to KMDF only]

The WDF_RETRIEVE_CHILD_FLAGS enumeration defines flags that a driver can set before calling WdfChildListBeginIteration.

Syntax

typedef enum _WDF_RETRIEVE_CHILD_FLAGS {
  WdfRetrieveUnspecified = 0x0000,
  WdfRetrievePresentChildren = 0x0001,
  WdfRetrieveMissingChildren = 0x0002,
  WdfRetrievePendingChildren = 0x0004,
  WdfRetrieveAddedChildren = (WdfRetrievePresentChildren | WdfRetrievePendingChildren),
  WdfRetrieveAllChildren = (WdfRetrievePresentChildren | WdfRetrievePendingChildren | WdfRetrieveMissingChildren)
} WDF_RETRIEVE_CHILD_FLAGS;

Constants

WdfRetrieveUnspecified Value: 0x0000 Reserved for internal use only.
WdfRetrievePresentChildren Value: 0x0001 Calls to WdfChildListRetrieveNextDevice will retrieve child devices for which a framework device object exists.
WdfRetrieveMissingChildren Value: 0x0002 Calls to WdfChildListRetrieveNextDevice will retrieve child devices that are marked as missing.
WdfRetrievePendingChildren Value: 0x0004 Calls to WdfChildListRetrieveNextDevice will retrieve child devices that the driver has reported as present, but for which a framework device object has not been created (because the framework has not called the driver's EvtChildListCreateDevice callback function).
WdfRetrieveAddedChildren Value: (WdfRetrievePresentChildren Calls to WdfChildListRetrieveNextDevice will retrieve child devices that are present or pending.
WdfRetrieveAllChildren Value: (WdfRetrievePresentChildren Calls to WdfChildListRetrieveNextDevice will retrieve child devices that are present, pending, or missing.

Remarks

Before calling WdfChildListBeginIteration, your driver must set WDF_RETRIEVE_CHILD_FLAGS-typed flags in a WDF_CHILD_LIST_ITERATOR structure.

Requirements

Requirement	Value
Minimum KMDF version	1.0
Header	wdfchildlist.h (include Wdf.h)

See also

EvtChildListCreateDevice

WDF_CHILD_LIST_ITERATOR

WdfChildListBeginIteration

WdfChildListRetrieveNextDevice