WdfPdoInitAssignInstanceID method
[Applies to KMDF only]
The WdfPdoInitAssignInstanceID method updates the instance ID for a child device.
Syntax
NTSTATUS WdfPdoInitAssignInstanceID( [in] PWDFDEVICE_INIT DeviceInit, [in] PCUNICODE_STRING InstanceID );
Parameters
- DeviceInit [in]
-
A pointer to a WDFDEVICE_INIT structure.
- InstanceID [in]
-
A pointer to a UNICODE_STRING structure that contains an instance ID string. The driver can allocate the string's buffer from paged pool.
Return value
If the operation succeeds, the method returns STATUS_SUCCESS. Additional return values include:
| Return code | Description |
|---|---|
|
The driver is initializing an FDO instead of a PDO. |
|
The driver could not allocate space to store the instance ID string. |
The method might also return other NTSTATUS values.
Remarks
For more information about instance IDs, see Device Identification Strings.
The driver must call WdfPdoInitAssignInstanceID before calling WdfDeviceCreate. For more information about calling WdfDeviceCreate, see Creating a Framework Device Object.
Examples
The following code example converts a device's serial number to a Unicode string and then registers the Unicode string as the device's instance ID.
DECLARE_UNICODE_STRING_SIZE(instanceID, INSTANCEID_LENGTH);
status = RtlIntegerToUnicodeString(
SerialNo,
BASE_DEC,
&instanceID
);
status = WdfPdoInitAssignInstanceID(
pDeviceInit,
&instanceID
);
Requirements
|
Minimum KMDF version | 1.0 |
|---|---|
|
Header |
|
|
Library |
|
|
IRQL | PASSIVE_LEVEL |
|
DDI compliance rules | ChildDeviceInitAPI, DriverCreate, InitFreeDeviceCallback, InitFreeDeviceCreate, InitFreeNull, KmdfIrql, KmdfIrql2, PdoDeviceInitAPI, PdoInitFreeDeviceCallback, PdoInitFreeDeviceCreate |
See also
- WdfPdoInitAssignDeviceID
- WdfPdoInitAddHardwareID
- WdfPdoInitAddCompatibleID
- RtlIntegerToUnicodeString
