Socket.SetSocketOption Method (SocketOptionLevel, SocketOptionName, Object)


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

Sets the specified Socket option to the specified value, represented as an object.

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

Public Sub SetSocketOption (
	optionLevel As SocketOptionLevel,
	optionName As SocketOptionName,
	optionValue As Object


Type: System.Net.Sockets.SocketOptionLevel

One of the SocketOptionLevel values.

Type: System.Net.Sockets.SocketOptionName

One of the SocketOptionName values.

Type: System.Object

A LingerOption or MulticastOption that contains the value of the option.

Exception Condition

optionValue is null.


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


The Socket has been closed.

Socket options determine the behavior of the current Socket. Use this overload to set the Linger, AddMembership, and DropMembershipSocket options. For the Linger option, use Socket for the optionLevel parameter. For AddMembership and DropMembership, use IP. If you want to get the current value of any of the options listed above, use the GetSocketOption method.


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.


You must call the Bind method before using AddMembership as the optionName parameter.

The following code example sets the LingerOption and Send time out values.

'Send operations will time-out if confirmation is 
' not received within 1000 milliseconds.
s.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.SendTimeout, 1000)

' The socket will linger for 10 seconds after Socket.Close is called.
Dim lingerOption As New LingerOption(True, 10)
s.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger, lingerOption)

.NET Framework
Available since 1.1
Return to top