WdfUsbInterfaceGetConfiguredSettingIndex - NtDoc

Native API online documentation, based on the System Informer (formerly Process Hacker) phnt headers
// wdfusb.h

BYTE WdfUsbInterfaceGetConfiguredSettingIndex(
  [in] WDFUSBINTERFACE Interface
);
View the official Windows Driver Kit DDI reference

NtDoc

No description available.

Windows Driver Kit DDI reference (nf-wdfusb-wdfusbinterfacegetconfiguredsettingindex)

WdfUsbInterfaceGetConfiguredSettingIndex function

Description

[Applies to KMDF and UMDF]

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

Parameters

Interface [in]

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);

See also

WdfUsbTargetDeviceGetInterface