Export (0) Print
Expand All

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

Returns the specified Socket option setting, represented as a byte array.

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

public void GetSocketOption(
	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 is to receive the option setting.

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.

Socket options determine the behavior of the current Socket. Upon successful completion of this method, the array specified by the optionValue parameter contains the value of the specified Socket option.

When the length of the optionValue array is smaller than the number of bytes required to store the value of the specified Socket option, GetSocketOption will throw a SocketException. 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. Use this overload for any sockets that are represented by Boolean values or integers.

NoteNote:

This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing.

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 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 ();
		Console::Write("This application will timeout if Send does not return within ");
		Console::WriteLine(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);

		//Displays to the screen.
		Console::WriteLine(Encoding::ASCII->GetString(bytes));
		s->Shutdown(SocketShutdown::Both);

		Console::Write("If data remains to be sent, this application will stay open for ");
		Console::WriteLine(__box(__try_cast<LingerOption *> (s->GetSocketOption(SocketOptionLevel::Socket, 
			SocketOptionName::Linger))->LingerTime)->ToString());
		s->Close();

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

Community Additions

ADD
Show:
© 2014 Microsoft