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

Switch View :
Classic
Lightweight
ScriptFree
.NET Framework Class Library
Socket.GetSocketOption Method (SocketOptionLevel, SocketOptionName, Byte[])

Returns the specified Socket option setting, represented as a byte array.

Namespace:  System.Net.Sockets
Assembly:  System (in System.dll)
Syntax
Visual Basic
Public Sub GetSocketOption ( _
	optionLevel As SocketOptionLevel, _
	optionName As SocketOptionName, _
	optionValue As Byte() _
)
C#
public void GetSocketOption(
	SocketOptionLevel optionLevel,
	SocketOptionName optionName,
	byte[] optionValue
)
Visual C++
public:
void GetSocketOption(
	SocketOptionLevel optionLevel, 
	SocketOptionName optionName, 
	array<unsigned char>^ optionValue
)
F#
member GetSocketOption : 
        optionLevel:SocketOptionLevel * 
        optionName:SocketOptionName * 
        optionValue:byte[] -> unit

Parameters

optionLevel
Type: System.Net.Sockets.SocketOptionLevel
One of the SocketOptionLevel values.
optionName
Type: System.Net.Sockets.SocketOptionName
One of the SocketOptionName values.
optionValue
Type: System.Byte[]
An array of type Byte that is to receive the option setting.
Exceptions
Exception Condition
SocketException

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

- or -

In .NET Compact Framework applications, the Windows CE default buffer space is set to 32768 bytes. You can change the per socket buffer space by calling SetSocketOption.
ObjectDisposedException

The Socket has been closed.

Remarks

Socket options determine the behavior of the current Socket. Upon successful completion of this method, the array specified by the optionValue parameter contains the value of the specified Socket option.

When the length of the optionValue array is smaller than the number of bytes required to store the value of the specified Socket option, GetSocketOption will throw a SocketException. 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. Use this overload for any sockets that are represented by Boolean values or integers.

Note 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
C#

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, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

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.
See Also

Reference

Socket Class
GetSocketOption Overload
System.Net.Sockets Namespace
SetSocketOption
SocketOptionName
SocketOptionLevel