Export (0) Print
Expand All

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 Object GetSocketOption(
	SocketOptionLevel optionLevel,
	SocketOptionName optionName
)

Parameters

optionLevel
Type: System.Net.Sockets.SocketOptionLevel
One of the SocketOptionLevel values.
optionName
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.

ExceptionCondition
SocketException

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

-or-

optionName was set to the unsupported value MaxConnections.

ObjectDisposedException

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.

NoteNote

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.

NoteNote

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

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


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

// blocks until send returns
int i = s.Send (msg);

// blocks until read returns
byte[] bytes = new byte[1024];

s.Receive (bytes);

//Display to the screen
Console.WriteLine (Encoding.ASCII.GetString (bytes));
s.Shutdown (SocketShutdown.Both);
Console.WriteLine ("If data remains to be sent, this application will stay open for " + ((LingerOption)s.GetSocketOption (SocketOptionLevel.Socket, SocketOptionName.Linger)).LingerTime.ToString ());
s.Close ();


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2014 Microsoft