IWDFDeviceAssignTransportSettings interface
[Warning: UMDF 2 is the latest version of UMDF and supersedes UMDF 1. All new UMDF drivers should be written using UMDF 2. No new features are being added to UMDF 1 and there is limited support for UMDF 1 on newer versions of Windows 10. Universal Windows drivers must use UMDF 2. For more info, see Getting Started with UMDF.]
The IWDFDeviceAssignTransportSettings interface exposes methods that drivers can use to set properties on a a multi-transport device's transport interface.
Members
The IWDFDeviceAssignTransportSettings interface inherits from the IUnknown interface. IWDFDeviceAssignTransportSettings also has these types of members:
- Methods
Methods
The IWDFDeviceAssignTransportSettings interface has these methods.
| Method | Description |
|---|---|
| IWDFDeviceAssignTransportSettings::AddCompositeCompatibleID | A transport driver's call to the AddCompositeCompatibleID method adds a compatible identifier (ID) to a list of compatible IDs that identify the logical composite device to which the transport is attached. |
| IWDFDeviceAssignTransportSettings::AddCompositeHardwareID | A transport driver's call to the AddCompositeHardwareID method adds a hardware identifier (ID) to a list of hardware IDs that identify the logical composite device to which the transport is attached. |
| IWDFDeviceAssignTransportSettings::AssignCompositeInstanceID | A transport driver's call to the AssignCompositeInstanceID method assigns an instance identifier (ID) to the logical composite device to which the transport is attached. |
| IWDFDeviceAssignTransportSettings::AssignReferenceString | The AssignReferenceString method assigns a reference string to a multi-transport device's transport interface. |
| IWDFDeviceAssignTransportSettings::CommitTransportSettings | The CommitTransportSettings method stores the transport settings that the driver has set by previous calls to other methods of the IWDFDeviceAssignTransportSettings interface. |
Remarks
Drivers obtain the IWDFDeviceAssignTransportSettings interface by calling IWDFDevice::QueryInterface.
Future versions of the framework might not support the IWDFDeviceAssignTransportSettings interface. Drivers for multi-transport devices should use Windows Portable Devices (WPD) interfaces, which are described in another section of this WDK documentation.
The WDK does not provide a header that declares the IWDFDeviceAssignTransportSettings interface. The interface definition language (IDL) definition of this interface is as follows:
//
// IWDFDeviceAssignTransportSettings Interface
//
[
object,
uuid(346A7103-30FB-4FCA-BC7C-9BB6B30B7CFC),
helpstring("Used to register an IWDFDevice instance as a transport device. "
"Retrieve by querying from the IWDFDevice interface"),
local,
restricted,
pointer_default(unique)
]
interface IWDFDeviceAssignTransportSettings : IUnknown
{
HRESULT
AssignReferenceString(
[in, annotation("__in")] PCWSTR pcwszReferenceString
);
HRESULT
AssignCompositeInstanceID(
[in, annotation("__in")] PCWSTR pcwszInstanceID
);
HRESULT
AddCompositeHardwareID(
[in, annotation("__in")] PCWSTR pcwszHardwareID
);
HRESULT
AddCompositeCompatibleID(
[in, annotation("__in")] PCWSTR pcwszCompatibleID
);
HRESULT
CommitTransportSettings(
void
);
};
Requirements
End of support |
Unavailable in UMDF 2.0 and later. |
Minimum UMDF version |
1.9 |