WDF_CHILD_ADDRESS_DESCRIPTION_HEADER structure (wdfchildlist.h)

[Applies to KMDF only]

The WDF_CHILD_ADDRESS_DESCRIPTION_HEADER structure is a header structure that must be the first member of every address description structure.

Syntax

typedef struct _WDF_CHILD_ADDRESS_DESCRIPTION_HEADER {
  ULONG AddressDescriptionSize;
} WDF_CHILD_ADDRESS_DESCRIPTION_HEADER, *PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER;

Members

AddressDescriptionSize

The size, in bytes, of a driver-defined structure that contains device address information.

Remarks

To initialize a WDF_CHILD_ADDRESS_DESCRIPTION_HEADER structure, your driver should call WDF_CHILD_ADDRESS_DESCRIPTION_HEADER_INIT.

The value that the driver specifies for the AddressDescriptionSize member must match the value it specifies for the AddressDescriptionSize member in its WDF_CHILD_LIST_CONFIG structure.

Address description structures are driver-defined. The driver must store the structure's size in the AddressDescriptionSize member. The size value must include the size of this header structure. For example, a driver might define an address descriptor as follows:

typedef struct _IEEE_1394_CHILD_ADDRESS_DESCRIPTION {
  WDF_CHILD_ADDRESS_DESCRIPTION_HEADER  AddressHeader;
  //
  // Current bus generation
  //
  ULONG Generation;
} IEEE_1394_CHILD_ADDRESS_DESCRIPTION, *PIEEE_1394_CHILD_ADDRESS_DESCRIPTION;

To set the AddressDescriptionSize member for this address descriptor, the driver can use the following code:

IEEE_1394_CHILD_ADDRESS_DESCRIPTION Addr_Description;
WDF_CHILD_ADDRESS_DESCRIPTION_HEADER_INIT (&Addr_Description, 
                                           sizeof(Addr_Description));

For more information about address descriptions, see Dynamic Enumeration.

Requirements

See also

WDF_CHILD_ADDRESS_DESCRIPTION_HEADER_INIT

WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER

WDF_CHILD_LIST_CONFIG