WdfPdoRetrieveIdentificationDescription method
[Applies to KMDF only]
The WdfPdoRetrieveIdentificationDescription method retrieves the identification description that is associated with a specified framework device object.
Syntax
NTSTATUS WdfPdoRetrieveIdentificationDescription( [in] WDFDEVICE Device, [in, out] PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER IdentificationDescription );
Parameters
- Device [in]
-
A handle to a framework device object that represents the device's physical device object (PDO).
- IdentificationDescription [in, out]
-
A pointer to a caller-allocated buffer that will receive the identification description. The identification description must contain a WDF_CHILD_IDENTIFICATION_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 WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER structure does not contain the correct buffer size. |
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 obtains a device's indentification description.
WDFDEVICE childPdo;
MY_IDENTIFICATION_DESCRIPTION IdentificationDescription;
NTSTATUS status;
WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER_INIT(
&IdentificationDescription.Header,
sizeof(IdentificationDescription)
);
status = WdfPdoRetrieveIdentificationDescription(
childPdo,
&IdentificationDescription.Header
);
Requirements
|
Minimum KMDF version | 1.0 |
|---|---|
|
Header |
|
|
Library |
|
|
IRQL | <= DISPATCH_LEVEL |
|
DDI compliance rules | DriverCreate, KmdfIrql, KmdfIrql2 |
See also
