UsbSetupPacket UsbSetupPacket UsbSetupPacket UsbSetupPacket Class

Describes the setup packet for a USB control transfer. For an explanation of the setup packet, see Table 9.2 in the Universal Serial Bus (USB) specification.

Syntax

Declaration

public sealed class UsbSetupPacketpublic sealed class UsbSetupPacketPublic NotInheritable Class UsbSetupPacket

Constructors summary

Creates a UsbSetupPacket object.

Creates a UsbSetupPacket object from a formatted buffer (eight bytes) that contains the setup packet.

Properties summary

Gets or sets the wIndex field in the setup packet of the USB control transfer.

Gets the length, in bytes, of the setup packet.

Gets or sets the bRequest field in the setup packet of the USB control transfer.

Gets or sets the bmRequestType field in the setup packet of the USB control transfer. That field is represented by a UsbControlRequestType object.

Gets or sets the wValue field in the setup packet of the USB control transfer.

Constructors

  • UsbSetupPacket()
    UsbSetupPacket()
    UsbSetupPacket()
    UsbSetupPacket()

    Creates a UsbSetupPacket object.

    public UsbSetupPacket()public UsbSetupPacket()Public Function UsbSetupPacket() As
  • UsbSetupPacket(Windows.Storage.Streams.IBuffer)
    UsbSetupPacket(Windows.Storage.Streams.IBuffer)
    UsbSetupPacket(Windows.Storage.Streams.IBuffer)
    UsbSetupPacket(Windows.Storage.Streams.IBuffer)

    Creates a UsbSetupPacket object from a formatted buffer (eight bytes) that contains the setup packet.

    public UsbSetupPacket(Windows.Storage.Streams.IBuffer eightByteBuffer)public UsbSetupPacket(Windows.Storage.Streams.IBuffer eightByteBuffer)Public Function UsbSetupPacket(eightByteBuffer As Windows.Storage.Streams.IBuffer) As

    Parameters

    • eightByteBuffer

      A caller-supplied buffer that contains the setup packet formatted as per the standard USB specification. The length of the buffer must be eight bytes because that is the size of a setup packet on the bus.

Properties

  • Index
    Index
    Index
    Index

    Gets or sets the wIndex field in the setup packet of the USB control transfer.

    public uint Index { get; set; }public uint Index { get; set; }Public ReadWrite Property Index As uint

    Property Value

    • uint
      uint
      uint
      uint

      The wIndex field in the setup packet. For an explanation of this field, see section 9.3.4 of the Universal Serial Bus (USB) specification.

  • Length
    Length
    Length
    Length

    Gets the length, in bytes, of the setup packet.

    public uint Length { get; set; }public uint Length { get; set; }Public ReadWrite Property Length As uint

    Property Value

    • uint
      uint
      uint
      uint

      The length, in bytes, of the setup packet.

  • Request
    Request
    Request
    Request

    Gets or sets the bRequest field in the setup packet of the USB control transfer.

    public byte Request { get; set; }public byte Request { get; set; }Public ReadWrite Property Request As byte

    Property Value

    • byte
      byte
      byte
      byte

      The bRequest field in the setup packet. For an explanation of this field, see section 9.3.2 of the Universal Serial Bus (USB) specification.

  • RequestType
    RequestType
    RequestType
    RequestType

    Gets or sets the bmRequestType field in the setup packet of the USB control transfer. That field is represented by a UsbControlRequestType object.

    public UsbControlRequestType RequestType { get; set; }public UsbControlRequestType RequestType { get; set; }Public ReadWrite Property RequestType As UsbControlRequestType

    Property Value

  • Value
    Value
    Value
    Value

    Gets or sets the wValue field in the setup packet of the USB control transfer.

    public uint Value { get; set; }public uint Value { get; set; }Public ReadWrite Property Value As uint

    Property Value

    • uint
      uint
      uint
      uint

      The wValue field in the setup packet and the value varies according to the request. For an explanation of this field, see section 9.3.3 of the Universal Serial Bus (USB) specification.

Attributes

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

Details

Assembly

Windows.Devices.Usb.dll