This documentation is archived and is not being maintained.

Socket.SetSocketOption Method (SocketOptionLevel, SocketOptionName, Object)

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

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

void SetSocketOption (
	SocketOptionLevel optionLevel, 
	SocketOptionName optionName, 
	Object^ optionValue
public void SetSocketOption (
	SocketOptionLevel optionLevel, 
	SocketOptionName optionName, 
	Object optionValue
public function SetSocketOption (
	optionLevel : SocketOptionLevel, 
	optionName : SocketOptionName, 
	optionValue : Object
Not applicable.



One of the SocketOptionLevel values.


One of the SocketOptionName values.


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

Exception typeCondition


optionValue is a null reference (Nothing in Visual Basic).


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.

Windows 98, Windows NT 4.0 Platform Note: You must call the Bind method before using AddMembership as the optionName parameter.

Windows Mobile 2003 for Pocket PC, Windows Mobile 2003 for Smartphone, Windows CE Platform Note: Not all socket options are supported on the .NET Compact Framework. For a list of options reserved for future use, see SocketOptionName.

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

// Specifies that send operations will time-out 
// if confirmation is not received within 1000 milliseconds.
s->SetSocketOption( SocketOptionLevel::Socket, SocketOptionName::SendTimeout, 1000 );

// Specifies that the Socket will linger for 10 seconds after Close is called.
LingerOption^ lingerOption = gcnew LingerOption( true,10 );

s->SetSocketOption( SocketOptionLevel::Socket, SocketOptionName::Linger, lingerOption );

// Send operations will time-out if confirmation 
// is not received within 1000 milliseconds.
    SocketOptionName.SendTimeout, 1000);
// The socket will linger for 10 seconds after Socket.Close is called.
LingerOption lingerOption = new LingerOption(true, 10);

s.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger, 

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0