Socket::Send Method (IList<ArraySegment<Byte>>, SocketFlags, SocketError%)

Sends the set of buffers in the list to a connected Socket, using the specified SocketFlags.

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

public:
int Send(
	IList<ArraySegment<unsigned char>>^ buffers, 
	SocketFlags socketFlags, 
	[OutAttribute] SocketError% errorCode
)

Parameters

buffers
Type: System.Collections.Generic::IList<ArraySegment<Byte>>

A list of ArraySegment<T>s of type Byte that contains the data to be sent.

socketFlags
Type: System.Net.Sockets::SocketFlags

A bitwise combination of the SocketFlags values.

errorCode
Type: System.Net.Sockets::SocketError%

A SocketError object that stores the socket error.

Return Value

Type: System::Int32
The number of bytes sent to the Socket.

ExceptionCondition
ArgumentNullException

buffers is nullptr.

ArgumentException

buffers is empty.

SocketException

An error occurred when attempting to access the socket. See the Remarks section for more information.

ObjectDisposedException

The Socket has been closed.

This overload requires at least one buffer that contains the data you want to send. The SocketFlags value defaults to 0. If you specify the DontRoute flag as the socketFlags parameter, the data you are sending will not be routed.

If you are using a connectionless protocol, you must call Connect before calling this method, or Send will throw a SocketException. If you are using a connection-oriented protocol, you must either use Connect to establish a remote host connection, or use Accept to accept an incoming connection.

If you are using a connectionless protocol and plan to send data to several different hosts, you should use the SendTo method. If you do not use the SendTo method, you will have to call Connect before each call to Send. You can use SendTo even after you have established a default remote host with Connect. You can also change the default remote host prior to calling Send by making another call to Connect.

If you are using a connection-oriented protocol, Send will block until all of the bytes in the buffer are sent, unless a time-out was set by using Socket::SendTimeout. If the time-out value was exceeded, the Send call will throw a SocketException. In non-blocking mode, Send may complete successfully even if it sends less than the number of bytes in the buffer. It is your application's responsibility to keep track of the number of bytes sent and to retry the operation until the application sends the bytes in the buffer. There is also no guarantee that the data you send will appear on the network immediately. To increase network efficiency, the underlying system may delay transmission until a significant amount of outgoing data is collected. A successful completion of the Send method means that the underlying system has had room to buffer your data for a network send.

NoteNote

If you receive a SocketException, use the SocketException::ErrorCode property to obtain the specific error code. After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation in the MSDN library for a detailed description of the error.

NoteNote

The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode.

NoteNote

This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing in the .NET Framework.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.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