UsbBulkInPipe UsbBulkInPipe UsbBulkInPipe UsbBulkInPipe UsbBulkInPipe Class

Definition

Namespace:
Windows.Devices.Usb Windows.Devices.Usb Windows.Devices.Usb Windows.Devices.Usb Windows.Devices.Usb
Edit

Represents the pipe that the underlying USB driver opens to communicate with a USB bulk IN endpoint of the device. The app can get an input stream from the pipe and access data is being read from the endpoint.

public : sealed class UsbBulkInPipe : IUsbBulkInPipe
struct winrt::Windows::Devices::Usb::UsbBulkInPipe : IUsbBulkInPipe
public sealed class UsbBulkInPipe : IUsbBulkInPipe
Public NotInheritable Class UsbBulkInPipe Implements IUsbBulkInPipe
// This class does not provide a public constructor.
Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

This code example shows how to read data from a bulk IN pipe. The example assumes that the app has previously obtained the UsbDevice object.

UsbDevice device;
UInt32 readLen = 8;

// Get the UsbDevice object. Not shown.

...

UsbBulkInPipe bulkIn = device.DefaultInterface.BulkInPipes[0];

DataReader reader = new DataReader(bulkIn.InputStream);

await reader.LoadAsync(readLen);

UInt64 data = reader.ReadUInt64();

ShowData(data);

Properties

EndpointDescriptor EndpointDescriptor EndpointDescriptor EndpointDescriptor EndpointDescriptor

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

Input stream that stores the data that the bulk IN pipe received from the endpoint.
MaxTransferSizeBytes MaxTransferSizeBytes MaxTransferSizeBytes MaxTransferSizeBytes MaxTransferSizeBytes

Gets the maximum number of bytes that can be read from the bulk IN pipe in a single transfer.
ReadOptions ReadOptions ReadOptions ReadOptions ReadOptions

Gets or sets configuration flags that controls the behavior of the pipe that reads data from a USB bulk IN endpoint.

Methods

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

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

Discards any data that is cached in the bulk IN pipe.