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


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

Begins an asynchronous write operation.

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

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


Type: System.Byte[]

The buffer that contains the data to write to the current stream.

Type: System.Int32

The zero-based byte offset in buffer at which to begin copying bytes to the current stream.

Type: System.Int32

The maximum number of bytes to write.

Type: System.AsyncCallback

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

Type: System.Object

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

Return Value

Type: System.IAsyncResult

An IAsyncResult object that references the asynchronous write operation.

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 write 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.

EndWrite must be called once for every call to BeginWrite. This can be done either in the same code that called BeginWrite or in a callback that is passed to BeginWrite.

Use the CanWrite property to determine whether the current PipeStream object supports write operations.

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

.NET Framework
Available since 3.5
Return to top