UsbInterfaceSetting UsbInterfaceSetting UsbInterfaceSetting UsbInterfaceSetting Class

Provides information about an alternate setting and select that setting. The app can get the USB interface descriptors for the setting and its endpoints, and determine whether this setting is currently selected.

Syntax

Declaration

public sealed class UsbInterfaceSettingpublic sealed class UsbInterfaceSettingPublic NotInheritable Class UsbInterfaceSetting

Remarks

For code example, see UsbInterface.

Properties summary

Gets an array of objects that represent descriptors associated with USB bulk IN endpoints that are defined in the alternate setting.

Gets an array of objects that represent descriptors associated with USB bulk OUT endpoints that are defined in the alternate setting.

Gets an array of objects that represent descriptors associated with the alternate setting.

Gets an object that represents the descriptor that describes the alternate setting.

Gets an array of objects that represent descriptors associated with USB interrupt IN endpoints that are defined in the alternate setting.

Gets an array of objects that represent descriptors associated with USB interrupt OUT endpoints that are defined in the alternate setting.

Determines whether the alternate setting is currently selected.

Methods summary

Selects the alternate setting as the current setting in the USB interface.

Properties

  • BulkInEndpoints
    BulkInEndpoints
    BulkInEndpoints
    BulkInEndpoints

    Gets an array of objects that represent descriptors associated with USB bulk IN endpoints that are defined in the alternate setting.

    public IVectorView<UsbBulkInEndpointDescriptor> BulkInEndpoints { get; }public IVectorView<UsbBulkInEndpointDescriptor> BulkInEndpoints { get; }Public ReadOnly Property BulkInEndpoints As IVectorView<UsbBulkInEndpointDescriptor>

    Property Value

  • BulkOutEndpoints
    BulkOutEndpoints
    BulkOutEndpoints
    BulkOutEndpoints

    Gets an array of objects that represent descriptors associated with USB bulk OUT endpoints that are defined in the alternate setting.

    public IVectorView<UsbBulkOutEndpointDescriptor> BulkOutEndpoints { get; }public IVectorView<UsbBulkOutEndpointDescriptor> BulkOutEndpoints { get; }Public ReadOnly Property BulkOutEndpoints As IVectorView<UsbBulkOutEndpointDescriptor>

    Property Value

  • Descriptors
    Descriptors
    Descriptors
    Descriptors

    Gets an array of objects that represent descriptors associated with the alternate setting.

    public IVectorView<UsbDescriptor> Descriptors { get; }public IVectorView<UsbDescriptor> Descriptors { get; }Public ReadOnly Property Descriptors As IVectorView<UsbDescriptor>

    Property Value

    • An array of UsbDescriptor objects that represent the interface descriptor associated with the alternate setting.

  • InterfaceDescriptor
    InterfaceDescriptor
    InterfaceDescriptor
    InterfaceDescriptor

    Gets an object that represents the descriptor that describes the alternate setting.

    public UsbInterfaceDescriptor InterfaceDescriptor { get; }public UsbInterfaceDescriptor InterfaceDescriptor { get; }Public ReadOnly Property InterfaceDescriptor As UsbInterfaceDescriptor

    Property Value

  • InterruptInEndpoints
    InterruptInEndpoints
    InterruptInEndpoints
    InterruptInEndpoints

    Gets an array of objects that represent descriptors associated with USB interrupt IN endpoints that are defined in the alternate setting.

    public IVectorView<UsbInterruptInEndpointDescriptor> InterruptInEndpoints { get; }public IVectorView<UsbInterruptInEndpointDescriptor> InterruptInEndpoints { get; }Public ReadOnly Property InterruptInEndpoints As IVectorView<UsbInterruptInEndpointDescriptor>

    Property Value

  • InterruptOutEndpoints
    InterruptOutEndpoints
    InterruptOutEndpoints
    InterruptOutEndpoints

    Gets an array of objects that represent descriptors associated with USB interrupt OUT endpoints that are defined in the alternate setting.

    public IVectorView<UsbInterruptOutEndpointDescriptor> InterruptOutEndpoints { get; }public IVectorView<UsbInterruptOutEndpointDescriptor> InterruptOutEndpoints { get; }Public ReadOnly Property InterruptOutEndpoints As IVectorView<UsbInterruptOutEndpointDescriptor>

    Property Value

  • Selected
    Selected
    Selected
    Selected

    Determines whether the alternate setting is currently selected.

    public bool Selected { get; }public bool Selected { get; }Public ReadOnly Property Selected As bool

    Property Value

    • bool
      bool
      bool
      bool

      True, if the alternate setting is currently selected; otherwise, false.

Methods

  • SelectSettingAsync()
    SelectSettingAsync()
    SelectSettingAsync()
    SelectSettingAsync()

    Selects the alternate setting as the current setting in the USB interface.

    public IAsyncAction SelectSettingAsync()public IAsyncAction SelectSettingAsync()Public Function SelectSettingAsync() As IAsyncAction

    Returns

    Remarks

    SelectSettingAsync() disables the endpoints of the previous alternate setting and removes the pipes associated with them from the UsbInterface object. The method enables the endpoints of this setting, and adds the associated pipes to the UsbInterface object.

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.DualApiPartitionAttribute
Windows.Foundation.Metadata.MarshalingBehaviorAttribute
Windows.Foundation.Metadata.ContractVersionAttribute

Details

Assembly

Windows.Devices.Usb.dll