IWDFUsbInterface::GetWinUsbHandle method (wudfusb.h)

[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 GetWinUsbHandle method retrieves the WinUsb interface handle that is associated with a USB interface.

Syntax

WINUSB_INTERFACE_HANDLE GetWinUsbHandle();

Return value

GetWinUsbHandle returns the WinUsb interface handle that is associated with the USB interface.

Remarks

If called on the default interface, the IWDFUsbInterface::GetWinUsbHandle method returns the same WinUsb interface handle as IWDFUsbTargetDevice::GetWinUsbHandle. The default interface is identified by index zero.

If called on interfaces with index greater than zero, IWDFUsbInterface::GetWinUsbHandle returns a different handle than IWDFUsbTargetDevice::GetWinUsbHandle.

A UMDF driver can use the WinUsb interface handle to bypass the UMDF interfaces and call WinUSB Routines directly for interface-related operations.

The UMDF driver should not call the WinUsb_Free function to free the WinUsb interface handle because the USB interface object owns the handle.

Requirements

Requirement	Value
End of support	Unavailable in UMDF 2.0 and later.
Target Platform	Desktop
Minimum UMDF version	1.5
Header	wudfusb.h (include Wudfusb.h)
DLL	WUDFx.dll

See also

IWDFUsbInterface

WinUsb_Free

WinUsb_Initialize