Edit

WDF_CHILD_LIST_CONFIG structure (wdfchildlist.h)

  • Article

[Applies to KMDF only]

The WDF_CHILD_LIST_CONFIG structure contains configuration information for a list of child devices.

Syntax

typedef struct _WDF_CHILD_LIST_CONFIG {
  ULONG                                                   Size;
  ULONG                                                   IdentificationDescriptionSize;
  ULONG                                                   AddressDescriptionSize;
  PFN_WDF_CHILD_LIST_CREATE_DEVICE                        EvtChildListCreateDevice;
  PFN_WDF_CHILD_LIST_SCAN_FOR_CHILDREN                    EvtChildListScanForChildren;
  PFN_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_COPY      EvtChildListIdentificationDescriptionCopy;
  PFN_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_DUPLICATE EvtChildListIdentificationDescriptionDuplicate;
  PFN_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_CLEANUP   EvtChildListIdentificationDescriptionCleanup;
  PFN_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_COMPARE   EvtChildListIdentificationDescriptionCompare;
  PFN_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_COPY             EvtChildListAddressDescriptionCopy;
  PFN_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_DUPLICATE        EvtChildListAddressDescriptionDuplicate;
  PFN_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_CLEANUP          EvtChildListAddressDescriptionCleanup;
  PFN_WDF_CHILD_LIST_DEVICE_REENUMERATED                  EvtChildListDeviceReenumerated;
} WDF_CHILD_LIST_CONFIG, *PWDF_CHILD_LIST_CONFIG;

Members

Size

The size, in bytes, of this structure.

IdentificationDescriptionSize

The size, in bytes, of each child's identification description. For more information, see WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER.

AddressDescriptionSize

The size, in bytes, of each child's address description. For more information, see WDF_CHILD_ADDRESS_DESCRIPTION_HEADER.

EvtChildListCreateDevice

A pointer to the driver's EvtChildListCreateDevice event callback function. This callback function is required.

EvtChildListScanForChildren

A pointer to the driver's EvtChildListScanForChildren event callback function. This callback function is optional.

EvtChildListIdentificationDescriptionCopy

A pointer to the driver's EvtChildListIdentificationDescriptionCopy event callback function. This callback function is optional.

EvtChildListIdentificationDescriptionDuplicate

A pointer to the driver's EvtChildListIdentificationDescriptionDuplicate event callback function. This callback function is optional.

EvtChildListIdentificationDescriptionCleanup

A pointer to the driver's EvtChildListIdentificationDescriptionCleanup event callback function. This callback function is optional.

EvtChildListIdentificationDescriptionCompare

A pointer to the driver's EvtChildListIdentificationDescriptionCompare event callback function. This callback function is optional.

EvtChildListAddressDescriptionCopy

A pointer to the driver's EvtChildListAddressDescriptionCopy event callback function. This callback function is optional.

EvtChildListAddressDescriptionDuplicate

A pointer to the driver's EvtChildListAddressDescriptionDuplicate event callback function. This callback function is optional.

EvtChildListAddressDescriptionCleanup

A pointer to the driver's EvtChildListAddressDescriptionCleanup event callback function. This callback function is optional.

EvtChildListDeviceReenumerated

A pointer to the driver's EvtChildListDeviceReenumerated event callback function. This callback function is optional.

Remarks

The WDF_CHILD_LIST_CONFIG structure is used as input to the WdfFdoInitSetDefaultChildListConfig and WdfChildListCreate methods.

To initialize a WDF_CHILD_LIST_CONFIG structure, the driver must call WDF_CHILD_LIST_CONFIG_INIT.

For more information about child lists, see Dynamic Enumeration.

Requirements

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

See also

WDF_CHILD_ADDRESS_DESCRIPTION_HEADER

WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER

WDF_CHILD_LIST_CONFIG_INIT

WdfChildListCreate

WdfFdoInitSetDefaultChildListConfig