WdfPdoUpdateAddressDescription method
[Applies to KMDF only]
The WdfPdoUpdateAddressDescription method updates the address description that is associated with a specified framework device object.
Syntax
NTSTATUS WdfPdoUpdateAddressDescription( [in] WDFDEVICE Device, [in, out] PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER AddressDescription );
Parameters
- Device [in]
-
A handle to a framework device object that represents a device's physical device object (PDO).
- AddressDescription [in, out]
-
A pointer to a caller-allocated buffer that contains an 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 |
|---|---|
|
The Device handle does not represent a PDO. |
|
The Device handle does not represent a device that was dynamically enumerated,or if the Size member of the specified WDF_CHILD_ADDRESS_DESCRIPTION_HEADER structure does not match the size of the device's existing address description. |
The method might also return other NTSTATUS values.
A system bug check occurs if the driver supplies an invalid object handle.
Examples
The following code example updates a device's address description with the current contents of the AddressDescription structure.
WDFDEVICE childPdo;
MY_ADDRESS_DESCRIPTION AddressDescription;
NTSTATUS status;
...
status = WdfPdoUpdateAddressDescription(
childPdo,
&AddressDescription.Header
);
Requirements
|
Minimum KMDF version | 1.0 |
|---|---|
|
Header |
|
|
Library |
|
|
IRQL | <= DISPATCH_LEVEL |
|
DDI compliance rules | DriverCreate, KmdfIrql, KmdfIrql2 |
See also
