Socket.GetSocketOption Method (SocketOptionLevel, SocketOptionName) (System.Net.Sockets)

Switch View :

ScriptFree

.NET Framework Class Library

Socket.GetSocketOption Method (SocketOptionLevel, SocketOptionName)

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

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

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

Syntax

Visual Basic


Public Function GetSocketOption ( _
	optionLevel As SocketOptionLevel, _
	optionName As SocketOptionName _
) As Object


public Object GetSocketOption(
	SocketOptionLevel optionLevel,
	SocketOptionName optionName
)

Visual C++


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


member GetSocketOption : 
        optionLevel:SocketOptionLevel * 
        optionName:SocketOptionName -> Object

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.

Exceptions

Exception	Condition
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.

Exception

Condition

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.

Remarks

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.

Note
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.

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

Examples

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

Visual Basic


    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
    Dim i As Integer = s.Send(msg)

    ' blocks until read returns
    Dim bytes(1024) As Byte
    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 " + CType(s.GetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger), LingerOption).LingerTime.ToString()))
    s.Close()
End Sub 'SetSocketOptions


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 ();

Visual C++


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() );
s->Close();

Version Information

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 8 Release Preview, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Reference

Socket Class

GetSocketOption Overload

System.Net.Sockets Namespace

SetSocketOption

SocketOptionName

SocketOptionLevel