PipeStream.BeginRead Method (Byte[], Int32, Int32, AsyncCallback, Object)


Begins an asynchronous read operation.

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

[HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)]
public override IAsyncResult BeginRead(
	byte[] buffer,
	int offset,
	int count,
	AsyncCallback callback,
	object state


Type: System.Byte[]

The buffer to read data into.

Type: System.Int32

The byte offset in buffer at which to begin reading.

Type: System.Int32

The maximum number of bytes to read.

Type: System.AsyncCallback

The method to call when the asynchronous read operation is completed.

Type: System.Object

A user-provided object that distinguishes this particular asynchronous read request from other requests.

Return Value

Type: System.IAsyncResult

An IAsyncResult object that references the asynchronous read.

Exception Condition

buffer is null.


offset is less than 0.


count is less than 0.


count is greater than the number of bytes available in buffer.


The pipe is closed.


The pipe does not support read operations.


The pipe is disconnected, waiting to connect, or the handle has not been set.


The pipe is broken or another I/O error occurred.

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