Stream.ReadAsync Method (Byte(), Int32, Int32)

.NET Framework (current version)

The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

Namespace:   System.IO
Assembly:  mscorlib (in mscorlib.dll)

<HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading := True)>
Public Function ReadAsync (
	buffer As Byte(),
	offset As Integer,
	count As Integer
) As Task(Of Integer)


Type: System.Byte()

The buffer to write the data into.

Type: System.Int32

The byte offset in buffer at which to begin writing data from the stream.

Type: System.Int32

The maximum number of bytes to read.

Return Value

Type: System.Threading.Tasks.Task(Of Int32)

A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached.

Exception Condition

buffer is null.


offset or count is negative.


The sum of offset and count is larger than the buffer length.


The stream does not support reading.


The stream has been disposed.


The stream is currently in use by a previous read operation.

The ReadAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. This performance consideration is particularly important in a Windows 8.x Store app or desktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Use the CanRead property to determine whether the current instance supports reading.

The following example shows how to read from a file asynchronously. The example uses the FileStream class, which derives from the Stream class.

Imports System.IO
Imports System.Text

Class MainWindow
    Private Async Sub Button_Click(sender As Object, e As RoutedEventArgs)
        Dim filename As String = "c:\Temp\userinputlog.txt"

        Dim result As Byte()

        Using SourceStream As FileStream = File.Open(filename, FileMode.Open)
            result = New Byte(SourceStream.Length - 1) {}
            Await SourceStream.ReadAsync(result, 0, CType(SourceStream.Length, Integer))
        End Using

        UserInput.Text = System.Text.Encoding.ASCII.GetString(result)
    End Sub
End Class

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.5
Portable Class Library
Supported in: portable .NET platforms
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1
Return to top