Share via

SetSocketOption Method (SocketOptionLevel, SocketOptionName, Int32)

  • Article

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Sets the specified Socket option to the specified integer value.

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

Syntax

'Declaration
Public Sub SetSocketOption ( _
    optionLevel As SocketOptionLevel, _
    optionName As SocketOptionName, _
    optionValue As Integer _
)

public void SetSocketOption(
    SocketOptionLevel optionLevel,
    SocketOptionName optionName,
    int optionValue
)

public:
void SetSocketOption(
    SocketOptionLevel optionLevel, 
    SocketOptionName optionName, 
    int optionValue
)

member SetSocketOption : 
        optionLevel:SocketOptionLevel * 
        optionName:SocketOptionName * 
        optionValue:int -> unit 

public function SetSocketOption(
    optionLevel : SocketOptionLevel, 
    optionName : SocketOptionName, 
    optionValue : int
)

Parameters

Remarks

Socket options determine the behavior of the current Socket. For an option with a Boolean data type, specify a nonzero value to enable the option, and a zero value to disable the option. For an option with an integer data type, specify the appropriate value. Socket options are grouped by level of protocol support.

Listed below are the various Socket options that can be set using this overload. These options are grouped by the appropriate SocketOptionLevel. If you intend to set any of these options, be sure to use the appropriate SocketOptionLevel for the optionLevel parameter. The option you choose to set must be specified in the optionName parameter. If you want to get the current value of any of the options listed, use the GetSocketOption method.

SocketOptionLevel..::..Socket options that can be set using this overload.

SocketOptionLevel..::..IP options that can be set using this overload.

SocketOptionLevel..::..Tcp options that can be set using this overload.

SocketOptionLevel..::..Udp options that can be set using this overload.

SocketOptionLevel..::..IPv6 options that can be set using this overload.

For more information about these options, refer to the SocketOptionName enumeration.

Note

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.

.NET Framework Security

See Also

Reference

Socket Class

SetSocketOption Overload

System.Net.Sockets Namespace