UsbBulkInPipe Class

Reference

Definition

Namespace:: Windows.Devices.Usb

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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 ref class UsbBulkInPipe sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class UsbBulkInPipe final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class UsbBulkInPipe

Public NotInheritable Class UsbBulkInPipe

Inheritance: Object Platform::Object IInspectable UsbBulkInPipe

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

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	Gets the object that represents endpoint descriptor associated with the USB bulk IN endpoint.
InputStream	Input stream that stores the data that the bulk IN pipe received from the endpoint.
MaxTransferSizeBytes	Gets the maximum number of bytes that can be read from the bulk IN pipe in a single transfer.
ReadOptions	Gets or sets configuration flags that controls the behavior of the pipe that reads data from a USB bulk IN endpoint.

Methods

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()	Discards any data that is cached in the bulk IN pipe.

Applies to

Share via