Stream.EndRead Method (System.IO)

EndRead Method

.NET Framework Class Library

Stream..::.EndRead Method

Waits for the pending asynchronous read to complete.

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

Syntax

Visual Basic (Declaration)

Public Overridable Function EndRead ( _
    asyncResult As IAsyncResult _
) As Integer

Visual Basic (Usage)

Dim instance As Stream
Dim asyncResult As IAsyncResult
Dim returnValue As Integer

returnValue = instance.EndRead(asyncResult)

public virtual int EndRead(
    IAsyncResult asyncResult
)

Visual C++

public:
virtual int EndRead(
    IAsyncResult^ asyncResult
)

JScript

public function EndRead(
    asyncResult : IAsyncResult
) : int

Parameters

asyncResult: Type: System..::.IAsyncResult
The reference to the pending asynchronous request to finish.

Return Value

Type: System..::.Int32
The 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 nullNothingnullptra null reference (Nothing in Visual Basic).
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

For an example of creating a file and writing text to a file, see How to: Write Text to a File. For an example of reading text from a file, see How to: Read Text from a File. For an example of reading from and writing to a binary file, see How to: Read and Write to a Newly Created Data File. For an example of asynchronous file I/O, see Asynchronous File I/O.

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.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Reference

Stream Class

Stream Members

System.IO Namespace

Other Resources

File and Stream I/O

How to: Read Text from a File

How to: Write Text to a File

Asynchronous File I/O