Sends data asynchronously to a connected Socket object.
Assembly: System (in System.dll)
Return ValueType: System.Boolean
Returns true if the I/O operation is pending. The SocketAsyncEventArgs.Completed event on the e parameter will be raised upon completion of the operation.
Returns false if the I/O operation completed synchronously. In this case, The SocketAsyncEventArgs.Completed event on the e parameter will not be raised and the e object passed as a parameter may be examined immediately after the method call returns to retrieve the result of the operation.
The SocketAsyncEventArgs.Buffer or SocketAsyncEventArgs.BufferList properties on the e parameter must reference valid buffers. One or the other of these properties may be set, but not both at the same time.
A socket operation was already in progress using the System.Net.Sockets.SocketAsyncEventArgs object specified in the e parameter.
Windows XP or later is required for this method.
The Socket has been closed.
The method is used to write outgoing data from one or more buffers on a connection-oriented socket. This method can also be used, however, on connectionless sockets that have specified a remote host on a connect operation.
The following properties and events on the System.Net.Sockets.SocketAsyncEventArgs object are required to successfully call this method:
The caller may set the SocketAsyncEventArgs.UserToken property to any user state object desired before calling the method, so that the information will be retrievable in the callback method. If the callback needs more information than a single object, a small class can be created to hold the other required state information as members.
Calling the method gives you the ability to send data within a separate execution thread.
For message-oriented sockets, do not exceed the maximum message size of the underlying Windows sockets service provider. If the data is too long to pass atomically through the underlying service provider, no data is transmitted and the method throws a SocketException with the SocketAsyncEventArgs.SocketError set to the native Winsock WSAEMSGSIZE error code (10040).
Note that the successful completion of the method does not indicate that the data was successfully delivered.
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.