Usb​Interface​Setting Usb​Interface​Setting Usb​Interface​Setting Class

Definition

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.

public sealed class UsbInterfaceSetting : IUsbInterfaceSettingpublic sealed class UsbInterfaceSetting : IUsbInterfaceSettingPublic NotInheritable Class UsbInterfaceSetting Implements IUsbInterfaceSetting
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

For code example, see UsbInterface.

Properties

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>
Value

An array of UsbBulkInEndpointDescriptor objects.

Attributes

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>
Value

An array of UsbBulkOutEndpointDescriptor objects.

Attributes

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>
Value

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

Attributes

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
Value
UsbInterfaceDescriptor UsbInterfaceDescriptor UsbInterfaceDescriptor

A UsbInterfaceDescriptor object that has the full descriptor for the alternate setting. Requirements

Attributes

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>
Value

An array of UsbInterruptInEndpointDescriptor objects.

Attributes

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>
Value

An array of UsbInterruptInEndpointDescriptor objects.

Attributes

Selected Selected Selected

Determines whether the alternate setting is currently selected.

public PlatForm::Boolean Selected { get; }public bool Selected { get; }Public ReadOnly Property Selected As bool
Value
bool bool bool

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

Attributes

Methods

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

An IAsyncAction object that is used to control the asynchronous operation.

Attributes

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.