.NET Framework Class Library
Stream.EndRead Method
Waits for the pending asynchronous read to complete.
Assembly: mscorlib (in mscorlib.dll)
Syntax
Visual Basic
Public Overridable Function EndRead ( _ asyncResult As IAsyncResult _ ) As Integer
C#
public virtual int EndRead( IAsyncResult asyncResult )
Visual C++
public: virtual int EndRead( IAsyncResult^ asyncResult )
F#
abstract EndRead : asyncResult:IAsyncResult -> int override EndRead : asyncResult:IAsyncResult -> int
Parameters
- asyncResult
- Type: System.IAsyncResult
The reference to the pending asynchronous request to finish.
Return Value
Type: System.Int32The number of bytes read from the stream, between zero (0) and the number of bytes you requested. Streams return zero (0) only at the end of the stream, otherwise, they should block until at least one byte is available.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException |
asyncResult is null. |
| ArgumentException |
asyncResult did not originate from a BeginRead method on the current stream. |
| IOException |
The stream is closed or an internal error has occurred. |
Remarks
Call EndRead to determine how many bytes were read from the stream.
EndRead can be called once on every IAsyncResult from BeginRead.
This method blocks until the I/O operation has completed.
Version Information
.NET Framework
Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0.NET Framework Client Profile
Supported in: 4, 3.5 SP1Portable Class Library
Supported in: Portable Class LibraryPlatforms
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
See Also