WdfUsbInterfaceGetConfiguredSettingIndex function (wdfusb.h)

[Applies to KMDF and UMDF]

The WdfUsbInterfaceGetConfiguredSettingIndex method returns the alternate setting index that is currently selected for a specified USB device interface.

Syntax

BYTE WdfUsbInterfaceGetConfiguredSettingIndex(
  [in] WDFUSBINTERFACE Interface
);

Parameters

[in] Interface

A handle to a USB interface object that was obtained by calling WdfUsbTargetDeviceGetInterface.

Return value

If the operation succeeds, WdfUsbInterfaceGetConfiguredSettingIndex returns the alternate setting index that is currently selected for the specified interface. If the interface is not configured, the method returns zero.

A bug check occurs if the driver supplies an invalid object handle.

Remarks

For more information about the WdfUsbInterfaceGetConfiguredSettingIndex method and USB I/O targets, see USB I/O Targets.

Examples

The following code example obtains the index for the currently selected alternate setting of a specified USB interface.

BYTE settingIndex;

settingIndex = WdfUsbInterfaceGetConfiguredSettingIndex(UsbInterface);

Requirements

Requirement	Value
Target Platform	Universal
Minimum KMDF version	1.0
Minimum UMDF version	2.0
Header	wdfusb.h (include Wdfusb.h)
Library	Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF)
IRQL	<=DISPATCH_LEVEL
DDI compliance rules	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), UsbKmdfIrql(kmdf), UsbKmdfIrql2(kmdf), UsbKmdfIrqlExplicit(kmdf)

See also

WdfUsbTargetDeviceGetInterface