UsbConfigurationDescriptor UsbConfigurationDescriptor UsbConfigurationDescriptor UsbConfigurationDescriptor Class

Derives information from the first 9 bytes of a USB configuration descriptor. The information includes the power capabilities of the device when the configuration is active and the number of interfaces included in that configuration. For an explanation of a configuration descriptor, Section 9.6.3 Universal Serial Bus Specification. For information about descriptor fields, see:

  • Table 9.15 in the Universal Serial Bus 3.0 Specification
  • Table 9.10 in the Universal Serial Bus Specification (version 2.0)

Syntax

Declaration

public sealed class UsbConfigurationDescriptorpublic sealed class UsbConfigurationDescriptorPublic NotInheritable Class UsbConfigurationDescriptor

Remarks

A USB device exposes its capabilities in the form of a USB configuration. A USB configuration is described in a configuration descriptor that the UsbConfigurationDescriptor class represents. For information about the descriptor, see USB configuration descriptors.

Properties summary

Gets the bConfigurationValue field of a USB configuration descriptor. The value is the number that identifies the configuration.

Gets the bMaxPower field of a USB configuration descriptor. The value indicates the maximum power (in milliamp units) that the device can draw from the bus, when the device is bus-powered.

Gets the D5 bit value of the bmAttributes field in the USB configuration descriptor. The value indicates whether the device can send a resume signal to wake up itself or the host system from a low power state.

Gets the D6 bit of the bmAttributes field in the USB configuration. This value indicates whether the device is drawing power from a local source or the bus.

Methods summary

Parses the specified USB descriptor and returns fields of a USB configuration descriptor.

Retrieves the first 9 bytes of a USB configuration descriptor in a UsbConfigurationDescriptor object that is contained in a UsbDescriptor object.

Properties

  • ConfigurationValue
    ConfigurationValue
    ConfigurationValue
    ConfigurationValue

    Gets the bConfigurationValue field of a USB configuration descriptor. The value is the number that identifies the configuration.

    public byte ConfigurationValue { get; }public byte ConfigurationValue { get; }Public ReadOnly Property ConfigurationValue As byte

    Property Value

    • byte
      byte
      byte
      byte

      The number that identifies the configuration.

  • MaxPowerMilliamps
    MaxPowerMilliamps
    MaxPowerMilliamps
    MaxPowerMilliamps

    Gets the bMaxPower field of a USB configuration descriptor. The value indicates the maximum power (in milliamp units) that the device can draw from the bus, when the device is bus-powered.

    public uint MaxPowerMilliamps { get; }public uint MaxPowerMilliamps { get; }Public ReadOnly Property MaxPowerMilliamps As uint

    Property Value

    • uint
      uint
      uint
      uint

      The maximum power (in milliamp units) that the device can draw from the bus.

  • RemoteWakeup
    RemoteWakeup
    RemoteWakeup
    RemoteWakeup

    Gets the D5 bit value of the bmAttributes field in the USB configuration descriptor. The value indicates whether the device can send a resume signal to wake up itself or the host system from a low power state.

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

    Property Value

    • bool
      bool
      bool
      bool

      True, if the device supports remote wakeup; otherwise false.

  • SelfPowered
    SelfPowered
    SelfPowered
    SelfPowered

    Gets the D6 bit of the bmAttributes field in the USB configuration. This value indicates whether the device is drawing power from a local source or the bus.

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

    Property Value

    • bool
      bool
      bool
      bool

      True, if the device is drawing power from a local source; false indicates that the device is only drawing power from the bus.

    Remarks

    If SelfPowered is true, the device is drawing power from a local source, and also some power from the bus. Get the MaxPowerMilliamps property value to determine the amount of power the device is drawing from the bus.

Methods

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

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

Details

Assembly

Windows.Devices.Usb.dll