Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

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)

public void GetSocketOption (
	SocketOptionLevel optionLevel,
	SocketOptionName optionName,
	byte[] optionValue
)
public void GetSocketOption (
	SocketOptionLevel optionLevel, 
	SocketOptionName optionName, 
	byte[] optionValue
)
public function GetSocketOption (
	optionLevel : SocketOptionLevel, 
	optionName : SocketOptionName, 
	optionValue : byte[]
)
Not applicable.

Parameters

optionLevel

One of the SocketOptionLevel values.

optionName

One of the SocketOptionName values.

optionValue

An array of type Byte that is to receive the option setting.

Exception typeCondition

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.

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.

NoteNote:

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

Windows Mobile 2003 for Pocket PC, Windows Mobile 2003 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.

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

    Console.WriteLine("This application will timeout if Send does not "
        + "return within " + Encoding.get_ASCII().GetString(s.
        GetSocketOption(SocketOptionLevel.Socket, 
        SocketOptionName.SendTimeout, 4)));
    // blocks until send returns
    int i = s.Send(msg);
    // blocks until read returns
    ubyte bytes[] = new ubyte[1024];

    s.Receive(bytes);
    //Display to the screen
    Console.WriteLine(Encoding.get_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))).get_LingerTime());
    s.Close();
} //SetSocketOptions


Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft