Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

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 byte[] GetSocketOption(
	SocketOptionLevel optionLevel,
	SocketOptionName optionName,
	int optionLength
)

Parameters

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

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

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.

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:
© 2015 Microsoft