BufferedStream.EndRead Method (IAsyncResult)

.NET Framework (current version)

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

Waits for the pending asynchronous read operation to complete. (Consider using ReadAsync instead; see the Remarks section.)

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

override EndRead : 
        asyncResult:IAsyncResult -> int


Type: System.IAsyncResult

The reference to the pending asynchronous request to wait for.

Return Value

Type: System.Int32

The number of bytes read from the stream, between 0 (zero) and the number of bytes you requested. Streams only return 0 only at the end of the stream, otherwise, they should block until at least 1 byte is available.

Exception Condition

asyncResult is null.


This IAsyncResult object was not created by calling BeginRead on this class.

In the .NET Framework 4 and earlier versions, you have to use methods such as BeginRead and EndRead to implement asynchronous file operations. These methods are still available in the .NET Framework 4.5 to support legacy code; however, the new async methods, such as ReadAsync, WriteAsync, and FlushAsync, help you implement asynchronous file operations more easily.

EndRead must be called with this IAsyncResult to find out how many bytes were read.

.NET Framework
Available since 4.5
Return to top