Socket::GetSocketOption Method (SocketOptionLevel, SocketOptionName)


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

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

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

Object^ GetSocketOption(
	SocketOptionLevel optionLevel,
	SocketOptionName optionName


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.

Exception Condition

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 DropMembershipSocket 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 in the .NET Framework.

The following code example retrieves the LingerOption and Send time-out values and displays them to the console.

Console::Write(  "This application will timeout if Send does not return within " );
Console::WriteLine( Encoding::ASCII->GetString( s->GetSocketOption( SocketOptionLevel::Socket, SocketOptionName::SendTimeout, 4 ) ) );

// Blocks until send returns.
int i = s->Send( msg );

// Blocks until read returns.
array<Byte>^ bytes = gcnew array<Byte>(1024);

s->Receive( bytes );

//Displays to the screen.
Console::WriteLine( Encoding::ASCII->GetString( bytes ) );
s->Shutdown( SocketShutdown::Both );
Console::Write(  "If data remains to be sent, this application will stay open for " );
Console::WriteLine( safe_cast<LingerOption^>(s->GetSocketOption( SocketOptionLevel::Socket, SocketOptionName::Linger ))->LingerTime.ToString() );

.NET Framework
Available since 1.1
Return to top