Socket::SetSocketOption Method (SocketOptionLevel, SocketOptionName, Int32)

Sets the specified Socket option to the specified integer value.

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

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

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::Int32
A 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. 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.

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.

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.


// Specifies that send operations will time-out 
// if confirmation is not received within 1000 milliseconds.
s->SetSocketOption( SocketOptionLevel::Socket, SocketOptionName::SendTimeout, 1000 );

// Specifies that the Socket will linger for 10 seconds after Close is called.
LingerOption^ lingerOption = gcnew LingerOption( true,10 );

s->SetSocketOption( SocketOptionLevel::Socket, SocketOptionName::Linger, lingerOption );


.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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft