PipeStream.EndRead Method (IAsyncResult)


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

Ends a pending asynchronous read request.

Namespace:   System.IO.Pipes
Assembly:  System.Core (in System.Core.dll)

public override int EndRead(
	IAsyncResult asyncResult


Type: System.IAsyncResult

The reference to the pending asynchronous request.

Return Value

Type: System.Int32

The number of bytes that were read. A return value of 0 indicates the end of the stream (the pipe has been closed).

Exception Condition

asyncResult is null.


asyncResult did not originate from a BeginRead method on the current stream.


The stream is closed or an internal error has occurred.

This method returns the number of bytes read into the byte array specified by the earlier call to BeginRead.

Pass the returned IAsyncResult object to the EndRead method to determine how many bytes were read and to release operating system resources used for reading. EndRead must be called once for every call to BeginRead. This can be done either in the same code that called BeginRead or in a callback that is passed to BeginRead.

Use the CanRead property to determine whether the current PipeStream object supports read operations.

If the pipe is closed or an invalid argument is passed to BeginRead, the appropriate exceptions are raised immediately. Errors that occur during an asynchronous read request occur on the thread pool thread that is performing the request. The exceptions are raised when the code calls the EndRead method.

.NET Framework
Available since 3.5
Return to top