NetworkStream.Write Method

Writes data to the NetworkStream.

Namespace:  System.Net.Sockets
Assembly:  System (in System.dll)

public override void Write(
	byte[] buffer,
	int offset,
	int size
)

Parameters

buffer
Type: System.Byte[]

An array of type Byte that contains the data to write to the NetworkStream.

offset
Type: System.Int32

The location in buffer from which to start writing data.

size
Type: System.Int32

The number of bytes to write to the NetworkStream.

ExceptionCondition
ArgumentNullException

The buffer parameter is null.

ArgumentOutOfRangeException

The offset parameter is less than 0.

-or-

The offset parameter is greater than the length of buffer.

-or-

The size parameter is less than 0.

-or-

The size parameter is greater than the length of buffer minus the value of the offset parameter.

IOException

There was a failure while writing to the network.

-or-

An error occurred when accessing the socket. See the Remarks section for more information.

ObjectDisposedException

The NetworkStream is closed.

-or-

There was a failure reading from the network.

The Write method starts at the specified offset and sends size bytes from the contents of buffer to the network. The Write method blocks until the requested number of bytes is sent or a SocketException is thrown. If you receive a SocketException, use the SocketException.ErrorCode property to obtain the specific error code, and refer to the Windows Sockets version 2 API error code documentation in MSDN for a detailed description of the error.

NoteNote

Check to see if the NetworkStream is writable by accessing the CanWrite property. If you attempt to write to a NetworkStream that is not writable, you will get an IOException. If you receive an IOException, check the InnerException property to determine if it was caused by a SocketException.

The following code example checks to see whether the NetworkStream is writable. If it is, then Write is used to write a small message.

            // Examples for CanWrite, and CanWrite   

            // Check to see if this NetworkStream is writable. 
            if (myNetworkStream.CanWrite){

                 byte[] myWriteBuffer = Encoding.ASCII.GetBytes("Are you receiving this message?");
                 myNetworkStream.Write(myWriteBuffer, 0, myWriteBuffer.Length);
            }
            else{
                 Console.WriteLine("Sorry.  You cannot write to this NetworkStream.");  
            }

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft