Stream.EndRead Method

Waits for the pending asynchronous read to complete.

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

Syntax

'Declaration
Public Overridable Function EndRead ( _
    asyncResult As IAsyncResult _
) As Integer
public virtual int EndRead(
    IAsyncResult asyncResult
)

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 nulla 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

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

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

See Also

Reference