Socket.SetSocketOption Method (SocketOptionLevel, SocketOptionName, Byte[])

Sets the specified Socket option to the specified value, represented as a byte array.

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

member SetSocketOption : 
        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 represents the value of the option.

ExceptionCondition
SocketException

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

ObjectDisposedException

The Socket has been closed.

Socket options determine the behavior of the current Socket. Use this overload to set those Socket options that require a byte array as an option value.

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 in the .NET Framework.

Windows 98, Windows NT 4.0 Platform Note: You must call the Bind method before using AddMembership as the optionName parameter.

The following code example sets the LingerOption and Send time-out values.

No code example is currently available or this language may not be supported.

.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

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), 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.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft