WDF_USB_INTERFACE_SELECT_SETTING_PARAMS_INIT_SETTING function (wdfusb.h)

Article
10/21/2021

[Applies to KMDF and UMDF]

The WDF_USB_INTERFACE_SELECT_SETTING_PARAMS_INIT_SETTING function initializes a WDF_USB_INTERFACE_SELECT_SETTING_PARAMS structure so that a driver can select a USB interface by specifying a handle to an interface object and an alternate setting for the interface.

Syntax

void WDF_USB_INTERFACE_SELECT_SETTING_PARAMS_INIT_SETTING(
  [out] PWDF_USB_INTERFACE_SELECT_SETTING_PARAMS Params,
  [in]  UCHAR                                    SettingIndex
);

Parameters

[out] Params

A pointer to a driver-allocated WDF_USB_INTERFACE_SELECT_SETTING_PARAMS structure.

[in] SettingIndex

An index value that identifies an alternate setting for the interface. (The interface is identified by an interface object handle that the driver passes to WdfUsbInterfaceSelectSetting.)

Return value

None

Remarks

The WDF_USB_INTERFACE_SELECT_SETTING_PARAMS_INIT_SETTING function zeros the WDF_USB_INTERFACE_SELECT_SETTING_PARAMS structure and sets its Size member to the size of the structure. It also sets the Type member to WdfUsbInterfaceSelectSettingTypeSetting and sets the Types.Interface.SettingIndex member to the value that is specified by SettingIndex.

To initialize a WDF_USB_INTERFACE_SELECT_SETTING_PARAMS structure, your driver must call one of the following functions:

WDF_USB_INTERFACE_SELECT_SETTING_PARAMS_INIT_DESCRIPTOR
WDF_USB_INTERFACE_SELECT_SETTING_PARAMS_INIT_SETTING
WDF_USB_INTERFACE_SELECT_SETTING_PARAMS_INIT_URB

For a code example that uses WDF_USB_INTERFACE_SELECT_SETTING_PARAMS_INIT_SETTING, see WdfUsbInterfaceSelectSetting.

Requirements

Requirement	Value
Target Platform	Universal
Minimum KMDF version	1.0
Minimum UMDF version	2.0
Header	wdfusb.h (include Wdfusb.h)