UsbInterruptInPipe UsbInterruptInPipe UsbInterruptInPipe UsbInterruptInPipe Class

Definition

Represents the pipe that the underlying USB driver opens to communicate with a USB interrupt IN endpoint of the device. The object also enables the app to specify an event handler. That handler that gets invoked when data is read from the endpoint.

public : sealed class UsbInterruptInPipe : IUsbInterruptInPipe
public sealed class UsbInterruptInPipe : IUsbInterruptInPipe
Public NotInheritable Class UsbInterruptInPipe Implements IUsbInterruptInPipe
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

When the app registers an event handler, the host controller polls the endpoint for data at regular intervals. That interval value can be obtained in the Interval property.

Properties

EndpointDescriptor EndpointDescriptor EndpointDescriptor EndpointDescriptor

Gets the object that represents the endpoint descriptor associated with the USB interrupt IN endpoint.

public : UsbInterruptInEndpointDescriptor EndpointDescriptor { get; }
public UsbInterruptInEndpointDescriptor EndpointDescriptor { get; }
Public ReadOnly Property EndpointDescriptor As UsbInterruptInEndpointDescriptor
var usbInterruptInEndpointDescriptor = usbInterruptInPipe.endpointDescriptor;
Value
UsbInterruptInEndpointDescriptor UsbInterruptInEndpointDescriptor UsbInterruptInEndpointDescriptor UsbInterruptInEndpointDescriptor

A UsbInterruptInEndpointDescriptor object that represents the endpoint descriptor associated with the USB interrupt IN endpoint.

Methods

ClearStallAsync() ClearStallAsync() ClearStallAsync() ClearStallAsync()

Starts an asynchronous operation to clear a stall condition (endpoint halt) on the USB interrupt IN endpoint that is associated with the pipe.

public : IAsyncAction ClearStallAsync()
public IAsyncAction ClearStallAsync()
Public Function ClearStallAsync() As IAsyncAction
var iAsyncAction = usbInterruptInPipe.clearStallAsync();
Returns

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

Events

DataReceived DataReceived DataReceived DataReceived

Raised when the interrupt pipe receives data from the interrupt IN endpoint.

public : event TypedEventHandler DataReceived<UsbInterruptInPipe,  UsbInterruptInEventArgs>
public event TypedEventHandler DataReceived<UsbInterruptInPipe,  UsbInterruptInEventArgs>
Public Event TypedEventHandler DataReceived( Of ( Of UsbInterruptInPipe ), ( Of  UsbInterruptInEventArgs ))
function onDataReceived(eventArgs){/* Your code */}


usbInterruptInPipe.addEventListener("dataReceived", onDataReceived);
usbInterruptInPipe.removeEventListener("dataReceived", onDataReceived);