WdfPdoInitAddCompatibleID - NtDoc
Native API online documentation, based on the System Informer
(formerly Process Hacker) phnt
headers
// wdfpdo.h
NTSTATUS WdfPdoInitAddCompatibleID(
[in] PWDFDEVICE_INIT DeviceInit,
[in] PCUNICODE_STRING CompatibleID
);
View the official Windows Driver Kit DDI referenceNo description available.
[Applies to KMDF only]
The WdfPdoInitAddCompatibleID method adds a compatible ID to the list of compatible IDs for a child device.
DeviceInit [in]A pointer to a WDFDEVICE_INIT structure.
CompatibleID [in]A pointer to a UNICODE_STRING structure that contains a compatible ID string. The driver can allocate the string's buffer from paged pool.
If the operation succeeds, the method returns STATUS_SUCCESS. Additional return values include:
| Return code | Description |
|---|---|
| STATUS_INVALID_DEVICE_REQUEST | The driver is initializing an FDO instead of a PDO. |
| STATUS_INSUFFICIENT_RESOURCES | The driver could not allocate space to store the compatible ID string. |
The method might also return other NTSTATUS values.
The driver can add one or more compatible IDs for a device. They should be added in order, from best match to worst match. The framework will deliver the IDs to the PnP manager in the order that they were added. For more information about compatible IDs, see Device Identification Strings and How Setup Selects Drivers.
The driver must call WdfPdoInitAddCompatibleID before calling WdfDeviceCreate. For more information about calling WdfDeviceCreate, see Creating a Framework Device Object.
The following code example reports a compatible ID value that the Toaster sample driver uses.
DECLARE_CONST_UNICODE_STRING(compatId, L"{B85B7C50-6A01-11d2-B841-00C04FAD5171}\\MsCompatibleToaster\0");
status = WdfPdoInitAddCompatibleID(
DeviceInit,
&compatId
);