UsbBulkOutPipe UsbBulkOutPipe UsbBulkOutPipe UsbBulkOutPipe Class

Represents the pipe that the underlying USB driver opens to communicate with a USB bulk OUT endpoint of the device. The object provides access to an output stream to which the app can write data to send to the endpoint.

Syntax

Declaration

public sealed class UsbBulkOutPipepublic sealed class UsbBulkOutPipePublic NotInheritable Class UsbBulkOutPipepublic sealed class UsbBulkOutPipe

Properties summary

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

Gets an output stream to which the app can write data to send to the endpoint.

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

Methods summary

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

Properties

  • EndpointDescriptor
    EndpointDescriptor
    EndpointDescriptor
    EndpointDescriptor

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

    public UsbBulkOutEndpointDescriptor EndpointDescriptor { get; }public UsbBulkOutEndpointDescriptor EndpointDescriptor { get; }Public ReadOnly Property EndpointDescriptor As UsbBulkOutEndpointDescriptorpublic UsbBulkOutEndpointDescriptor EndpointDescriptor { get; }

    Property Value

  • OutputStream
    OutputStream
    OutputStream
    OutputStream

    Gets an output stream to which the app can write data to send to the endpoint.

    public IOutputStream OutputStream { get; }public IOutputStream OutputStream { get; }Public ReadOnly Property OutputStream As IOutputStreampublic IOutputStream OutputStream { get; }

    Property Value

    Remarks

    To write data, first get the output stream from the pipe by using OutputStream property and then use the DataWriter object to write the actual buffer.

        Windows::Storage::Streams::Buffer^ buffer = ref new Windows::Storage::Streams::Buffer(TRANSFER_SIZE);  
    
        buffer->Length = TRANSFER_SIZE;  
    
        auto stream = DeviceList::Current->Fx2Device->Configuration->UsbInterfaces->GetAt(0)->BulkOutPipes->GetAt(0)->OutputStream;  
    
        Windows::Storage::Streams::DataWriter^ writer = ref new Windows::Storage::Streams::DataWriter(stream);  
    
        writer->WriteBuffer(buffer);  
    
    
        });  
    
  • WriteOptions
    WriteOptions
    WriteOptions
    WriteOptions

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

    public UsbWriteOptions WriteOptions { get; set; }public UsbWriteOptions WriteOptions { get; set; }Public ReadWrite Property WriteOptions As UsbWriteOptionspublic UsbWriteOptions WriteOptions { get; set; }

    Property Value

Methods

  • ClearStallAsync()
    ClearStallAsync()
    ClearStallAsync()
    ClearStallAsync()

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

    public IAsyncAction ClearStallAsync()public IAsyncAction ClearStallAsync()Public Function ClearStallAsync() As IAsyncActionpublic IAsyncAction ClearStallAsync()

    Returns

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

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

Details

Assembly

Windows.Devices.Usb.dll