This documentation is archived and is not being maintained.

Socket.GetSocketOption Method (SocketOptionLevel, SocketOptionName)

Returns the value of a specified Socket option, represented as an object.

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

public function GetSocketOption(
	optionLevel : SocketOptionLevel, 
	optionName : SocketOptionName
) : Object


Type: System.Net.Sockets.SocketOptionLevel

One of the SocketOptionLevel values.

Type: System.Net.Sockets.SocketOptionName

One of the SocketOptionName values.

Return Value

Type: System.Object
An object that represents the value of the option. When the optionName parameter is set to Linger the return value is an instance of the LingerOption class. When optionName is set to AddMembership or DropMembership, the return value is an instance of the MulticastOption class. When optionName is any other value, the return value is an integer.


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


optionName was set to the unsupported value MaxConnections.


The Socket has been closed.

Socket options determine the behavior of the current Socket. Use this overload to get the Linger, AddMembership, and DropMembership Socket options. For the Linger option, use Socket for the optionLevel parameter. For AddMembership and DropMembership, use IP. If you want to set the value of any of the options listed above, use the SetSocketOption 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.


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

Windows Mobile for Pocket PC, Windows Mobile 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 retrieves the LingerOption and Send time-out values and displays them to the console.

No code example is currently available or this language may not be supported.
		Console::Write("This application will timeout if Send does not return within ");
			SocketOptionName::SendTimeout, 4)));
		// Blocks until send returns.
		int i = s->Send(msg);

		// Blocks until read returns.
		Byte bytes[] = new Byte[1024];

		//Displays to the screen.

		Console::Write("If data remains to be sent, this application will stay open for ");
		Console::WriteLine(__box(__try_cast<LingerOption *> (s->GetSocketOption(SocketOptionLevel::Socket, 

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.

.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