NetworkStream.Write Method (System.Net.Sockets)

Switch View

Write Method

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

NetworkStream..::.Write Method

Writes data to the NetworkStream.

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

Syntax

Visual Basic (Declaration)

Public Overrides Sub Write ( _
    buffer As Byte(), _
    offset As Integer, _
    size As Integer _
)

Visual Basic (Usage)

Dim instance As NetworkStream
Dim buffer As Byte()
Dim offset As Integer
Dim size As Integer

instance.Write(buffer, offset, size)

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

Visual C++

public:
virtual void Write(
    array<unsigned char>^ buffer, 
    int offset, 
    int size
) override

JScript

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

Parameters

buffer: Type: array<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.

Exceptions

Exception	Condition
ArgumentNullException	The buffer parameter is nullNothingnullptra null reference (Nothing in Visual Basic).
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.

Remarks

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.

Note:
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.

Examples

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

Visual Basic

' Examples for CanWrite, and CanWrite  
' Check to see if this NetworkStream is writable.
If myNetworkStream.CanWrite Then

   Dim myWriteBuffer As Byte() = Encoding.ASCII.GetBytes("Are you receiving this message?")
   myNetworkStream.Write(myWriteBuffer, 0, myWriteBuffer.Length)
Else
   Console.WriteLine("Sorry.  You cannot write to this NetworkStream.")
End If

// 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.");  
}

Visual C++

// Examples for CanWrite, and CanWrite  
// Check to see if this NetworkStream is writable.
if ( myNetworkStream->CanWrite )
{
   array<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." );
}

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

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

Version Information

.NET Framework

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

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

Reference

NetworkStream Class

NetworkStream Members

System.Net.Sockets Namespace

CanWrite

Writeable