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)

public void SetSocketOption(
	SocketOptionLevel optionLevel,
	SocketOptionName optionName,
	byte[] 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.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.

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

Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows CE Platform Note: Not all socket options are supported on the .NET Compact Framework. For a list of options reserved for future use, see SocketOptionName.

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

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

// The socket will linger for 10 seconds after Socket.Close is called.
LingerOption lingerOption = new LingerOption (true, 10);

s.SetSocketOption (SocketOptionLevel.Socket, SocketOptionName.Linger, lingerOption);
		// 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 = new LingerOption(true, 10);
		s->SetSocketOption(SocketOptionLevel::Socket, SocketOptionName::Linger, lingerOption);

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft