Socket.GetSocketOption Method (SocketOptionLevel, SocketOptionName, Int32)


Returns the value of the specified Socket option in an array.

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

Public Function GetSocketOption (
	optionLevel As SocketOptionLevel,
	optionName As SocketOptionName,
	optionLength As Integer
) As Byte()


Type: System.Net.Sockets.SocketOptionLevel

One of the SocketOptionLevel values.

Type: System.Net.Sockets.SocketOptionName

One of the SocketOptionName values.

Type: System.Int32

The length, in bytes, of the expected return value.

Return Value

Type: System.Byte()

An array of type Byte that contains the value of the socket option.

Exception Condition

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.


The Socket has been closed.

The optionLength parameter sets the maximum size of the returned byte array. If the option value requires fewer bytes, the array will contain only that many bytes. If the option value requires more bytes, GetSocketOption will throw a SocketException. Use this overload for any sockets that are represented by Boolean values or integers.


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.

Legacy Code Example

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

    ' blocks until read returns
    Dim bytes(1024) As Byte

    'Display to the screen

    Console.WriteLine(("If data remains to be sent, this application will stay open for " + CType(s.GetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger), LingerOption).LingerTime.ToString()))
End Sub 'SetSocketOptions

.NET Framework
Available since 1.1
Return to top
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2015 Microsoft