Socket.GetSocketOption Method (SocketOptionLevel, SocketOptionName, Byte[])
Assembly: System (in system.dll)
public void GetSocketOption ( SocketOptionLevel optionLevel, SocketOptionName optionName, byte[] optionValue )
public void GetSocketOption ( SocketOptionLevel optionLevel, SocketOptionName optionName, byte[] optionValue )
public function GetSocketOption ( optionLevel : SocketOptionLevel, optionName : SocketOptionName, optionValue : byte[] )
Parameters
- optionLevel
One of the SocketOptionLevel values.
- optionName
One of the SocketOptionName values.
- optionValue
An array of type Byte that is to receive the option setting.
| Exception type | Condition |
|---|---|
| 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. | |
| 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.
 Note |
|---|
| This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing. |
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.WriteLine("This application will timeout if Send does not "
+ "return within " + Encoding.get_ASCII().GetString(s.
GetSocketOption(SocketOptionLevel.Socket,
SocketOptionName.SendTimeout, 4)));
// blocks until send returns
int i = s.Send(msg);
// blocks until read returns
ubyte bytes[] = new ubyte[1024];
s.Receive(bytes);
//Display to the screen
Console.WriteLine(Encoding.get_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))).get_LingerTime());
s.Close();
} //SetSocketOptions
Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.
