Edit

WdfPdoRetrieveAddressDescription function (wdfpdo.h)

  • Article

[Applies to KMDF only]

The WdfPdoRetrieveAddressDescription method retrieves the address description that is associated with a specified framework device object.

Syntax

NTSTATUS WdfPdoRetrieveAddressDescription(
  [in]      WDFDEVICE                             Device,
  [in, out] PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER AddressDescription
);

Parameters

[in] Device

A handle to a framework device object that represents the device's physical device object (PDO).

[in, out] AddressDescription

A pointer to a caller-allocated buffer that will receive the address description. The address description must contain a WDF_CHILD_ADDRESS_DESCRIPTION_HEADER structure.

Return value

If the operation succeeds, the function returns STATUS_SUCCESS. Additional return values include:

Return code Description
STATUS_INVALID_PARAMETER
 The Device handle does not represent a PDO.
STATUS_INVALID_DEVICE_REQUEST
 The Device handle does not represent a device that was dynamically enumerated.
 

The method might also return other NTSTATUS values.

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

Requirements

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

WDF_CHILD_ADDRESS_DESCRIPTION_HEADER_INIT

WdfChildListRetrieveAddressDescription

WdfPdoRetrieveIdentificationDescription