IWDFUsbTargetDevice::RetrieveUsbInterface method (wudfusb.h)

Article
10/21/2021

[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 RetrieveUsbInterface method retrieves the specified USB interface for a USB device.

Syntax

HRESULT RetrieveUsbInterface(
  [in]  UCHAR            InterfaceIndex,
  [out] IWDFUsbInterface **ppUsbInterface
);

Parameters

[in] InterfaceIndex

The index of the interface to retrieve.

[out] ppUsbInterface

A pointer to a variable that receives a pointer to the specified IWDFUsbInterface interface for the USB device.

Return value

RetrieveUsbInterface returns one of the following values:

Return code	Description
S_OK	RetrieveUsbInterface successfully retrieved the specified USB interface for the USB device.
E_OUTOFMEMORY	RetrieveUsbInterface encountered an allocation failure.
An error code that is defined in Winerror.h	This value corresponds to the error code that the WinUsb API returned.

Remarks

The driver can call the IWDFUsbTargetDevice::GetNumInterfaces method to retrieve the total number of USB interfaces that are available.

The driver can use the interface pointer that RetrieveUsbInterface retrieves, to call the methods that the IWDFUsbInterface interface provides. For more information about using these methods, see Working with USB Interfaces in UMDF.

Examples

For a code example of how to use the RetrieveUsbInterface method, see IWDFUsbTargetFactory::CreateUsbTargetDevice.

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

Share via