Windows hardware
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

UsbBulkInPipe class

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.

Syntax


Public NotInheritable Class UsbBulkInPipe

Members

The UsbBulkInPipe class has these types of members:

Methods

The UsbBulkInPipe class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

MethodDescription
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.

 

Properties

The UsbBulkInPipe class has these properties.

PropertyAccess typeDescription

EndpointDescriptor

Read-only

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

InputStream

Read-only

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

MaxTransferSizeBytes

Read-only

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

ReadOptions

Read/write

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

 

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);

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.Devices.Usb
Windows::Devices::Usb [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8.1 [Windows Store apps, desktop apps]

Minimum supported server

Windows Server 2012 R2 [Windows Store apps, desktop apps]

Minimum supported phone

None supported

Namespace

Windows.Devices.Usb
Windows::Devices::Usb [C++]

Metadata

Windows.winmd

Attributes

[DualApiPartition()]
[MarshalingBehavior(Agile)]
[Version(0x06030000)]

See also

Object

 

 

Show:
© 2016 Microsoft