I​Input​Stream I​Input​Stream I​Input​Stream Interface

Definition

Represents a sequential stream of bytes to be read.

public interface IInputStreampublic interface IInputStreamPublic Interface IInputStream
Inheritance
IInputStreamIInputStreamIInputStream
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Inherited Members

Inherited methods

Methods

ReadAsync(IBuffer, UInt32, InputStreamOptions) ReadAsync(IBuffer, UInt32, InputStreamOptions) ReadAsync(IBuffer, UInt32, InputStreamOptions)

Reads data from the stream asynchronously.

public IAsyncOperationWithProgress<IBuffer, uint> ReadAsync(IBuffer buffer, UInt32 count, InputStreamOptions options)public IAsyncOperationWithProgress<IBuffer, uint> ReadAsync(IBuffer buffer, UInt32 count, InputStreamOptions options)Public Function ReadAsync(buffer As IBuffer, count As UInt32, options As InputStreamOptions) As IAsyncOperationWithProgress( Of IBuffer, uint )
Parameters
buffer
IBuffer IBuffer IBuffer

A buffer that may be used to return the bytes that are read. The return value contains the buffer that holds the results.

count
System.UInt32 System.UInt32 System.UInt32

The number of bytes to read that is less than or equal to the Capacity value.

options
InputStreamOptions InputStreamOptions InputStreamOptions

Specifies the type of the asynchronous read operation.

Returns

The asynchronous operation.

Attributes

Remarks

Always read data from the buffer returned in the IAsyncOperationWithProgress(IBuffer, UInt32). Don't assume that the input buffer contains the data. Depending on the implementation, the data that's read might be placed into the input buffer, or it might be returned in a different buffer. For the input buffer, you don't have to implement the IBuffer interface. Instead, you can create an instance of the Buffer class.

Also consider reading a buffer into an IInputStream by using the ReadBuffer method of the DataReader class.