Socket.GetSocketOption 方法

參考

定義

命名空間:: System.Net.Sockets

組件:: System.Net.Sockets.dll

組件:: System.dll

組件:: netstandard.dll

重要

部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。

傳回 Socket 選項值。

多載

GetSocketOption(SocketOptionLevel, SocketOptionName, Byte[])	傳回指定的 Socket 選項設定，表示為位元組陣列。
GetSocketOption(SocketOptionLevel, SocketOptionName, Int32)	以陣列傳回指定 Socket 選項的值。
GetSocketOption(SocketOptionLevel, SocketOptionName)	傳回指定 Socket 選項的值，表示為物件。

GetSocketOption(SocketOptionLevel, SocketOptionName, Byte[])

來源:: Socket.cs

來源:: Socket.cs

來源:: Socket.cs

傳回指定的 Socket 選項設定，表示為位元組陣列。

public:
 void GetSocketOption(System::Net::Sockets::SocketOptionLevel optionLevel, System::Net::Sockets::SocketOptionName optionName, cli::array <System::Byte> ^ optionValue);

public void GetSocketOption (System.Net.Sockets.SocketOptionLevel optionLevel, System.Net.Sockets.SocketOptionName optionName, byte[] optionValue);

member this.GetSocketOption : System.Net.Sockets.SocketOptionLevel * System.Net.Sockets.SocketOptionName * byte[] -> unit

Public Sub GetSocketOption (optionLevel As SocketOptionLevel, optionName As SocketOptionName, optionValue As Byte())

參數

optionLevel: SocketOptionLevel

其中一個 SocketOptionLevel 值。

optionName: SocketOptionName

其中一個 SocketOptionName 值。

optionValue: Byte[]

Byte 型別的陣列，將要接收選項設定。

例外狀況

SocketException

嘗試存取通訊端時發生錯誤。

-或-

在 .NET Compact Framework 應用程式中，Windows CE 的預設緩衝區空間設為 32768 個位元組。您可以呼叫 SetSocketOption，以變更每個通訊端緩衝區空間。

ObjectDisposedException

Socket 已關閉。

範例

下列程式碼範例會擷 LingerOption 取和 Send 逾時值，並將其顯示至主控台。

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.
array<Byte>^ bytes = gcnew array<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(safe_cast<LingerOption^>(s->GetSocketOption(SocketOptionLevel::Socket, SocketOptionName::Linger))->LingerTime.ToString());
s->Close();

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.ASCII.GetString(s.GetSocketOption(SocketOptionLevel.Socket, SocketOptionName.SendTimeout, 4))))
    ' blocks until send returns
    Dim i As Integer = s.Send(msg)

    ' blocks until read returns
    Dim bytes(1024) As Byte
    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 " + CType(s.GetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger), LingerOption).LingerTime.ToString()))
    s.Close()
End Sub

備註

Socket 選項會決定目前 Socket 的行為。成功完成這個方法時，參數所 optionValue 指定的陣列會包含指定 Socket 選項的值。

當陣列的 optionValue 長度小於儲存指定 Socket 選項值所需的位元組數目時， GetSocketOption 將會擲回 SocketException 。如果您收到 SocketException ，請使用 SocketException.ErrorCode 屬性來取得特定的錯誤碼。取得此程式碼之後，請參閱 Windows Sockets 第 2 版 API 錯誤碼檔，以取得錯誤的詳細描述。針對布林值或整數所代表的任何通訊端，請使用這個多載。

注意

在應用程式中啟用網路追蹤時，這個成員會輸出追蹤資訊。如需詳細資訊，請參閱.NET Framework 中的網路追蹤。

另請參閱

適用於

GetSocketOption(SocketOptionLevel, SocketOptionName, Int32)

來源:: Socket.cs

來源:: Socket.cs

來源:: Socket.cs

以陣列傳回指定 Socket 選項的值。

public:
 cli::array <System::Byte> ^ GetSocketOption(System::Net::Sockets::SocketOptionLevel optionLevel, System::Net::Sockets::SocketOptionName optionName, int optionLength);

public byte[] GetSocketOption (System.Net.Sockets.SocketOptionLevel optionLevel, System.Net.Sockets.SocketOptionName optionName, int optionLength);

member this.GetSocketOption : System.Net.Sockets.SocketOptionLevel * System.Net.Sockets.SocketOptionName * int -> byte[]

Public Function GetSocketOption (optionLevel As SocketOptionLevel, optionName As SocketOptionName, optionLength As Integer) As Byte()

參數

optionLevel: SocketOptionLevel

其中一個 SocketOptionLevel 值。

optionName: SocketOptionName

其中一個 SocketOptionName 值。

optionLength: Int32

要限制的傳回值長度，以位元組為單位。

傳回

Byte[]

Byte 型別的陣列，包含通訊端選項值。

例外狀況

SocketException

嘗試存取通訊端時發生錯誤。

-或-

在 .NET Compact Framework 應用程式中，Windows CE 的預設緩衝區空間設為 32768 個位元組。您可以呼叫 SetSocketOption，以變更每個通訊端緩衝區空間。

ObjectDisposedException

Socket 已關閉。

範例

下列程式碼範例會擷 LingerOption 取和 Send 逾時值，並將其顯示至主控台。

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.
array<Byte>^ bytes = gcnew array<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(safe_cast<LingerOption^>(s->GetSocketOption(SocketOptionLevel::Socket, SocketOptionName::Linger))->LingerTime.ToString());
s->Close();

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.ASCII.GetString(s.GetSocketOption(SocketOptionLevel.Socket, SocketOptionName.SendTimeout, 4))))
    ' blocks until send returns
    Dim i As Integer = s.Send(msg)

    ' blocks until read returns
    Dim bytes(1024) As Byte
    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 " + CType(s.GetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger), LingerOption).LingerTime.ToString()))
    s.Close()
End Sub

備註

參數 optionLength 會設定傳回位元組陣列的大小上限。如果選項值需要較少的位元組，陣列只會包含該多位元組。如果選項值需要更多位元組， GetSocketOption 將會擲回 SocketException 。針對布林值或整數所代表的任何通訊端，請使用這個多載。

注意

如果您收到 SocketException ，請使用 SocketException.ErrorCode 屬性來取得特定的錯誤碼。取得此程式碼之後，請參閱 Windows Sockets 第 2 版 API 錯誤碼檔，以取得錯誤的詳細描述。

注意

在應用程式中啟用網路追蹤時，這個成員會輸出追蹤資訊。如需詳細資訊，請參閱.NET Framework 中的網路追蹤。

另請參閱

適用於

GetSocketOption(SocketOptionLevel, SocketOptionName)

來源:: Socket.cs

來源:: Socket.cs

來源:: Socket.cs

傳回指定 Socket 選項的值，表示為物件。

public:
 System::Object ^ GetSocketOption(System::Net::Sockets::SocketOptionLevel optionLevel, System::Net::Sockets::SocketOptionName optionName);

public object? GetSocketOption (System.Net.Sockets.SocketOptionLevel optionLevel, System.Net.Sockets.SocketOptionName optionName);

public object GetSocketOption (System.Net.Sockets.SocketOptionLevel optionLevel, System.Net.Sockets.SocketOptionName optionName);

member this.GetSocketOption : System.Net.Sockets.SocketOptionLevel * System.Net.Sockets.SocketOptionName -> obj

Public Function GetSocketOption (optionLevel As SocketOptionLevel, optionName As SocketOptionName) As Object

參數

optionLevel: SocketOptionLevel

其中一個 SocketOptionLevel 值。

optionName: SocketOptionName

其中一個 SocketOptionName 值。

傳回

Object

表示選項值的物件。當 optionName 參數設為 Linger 時，傳回值將會是 LingerOption 類別的執行個體。當 optionName 設為 AddMembership 或 DropMembership 時，傳回值將會是 MulticastOption 類別的執行個體。當 optionName 是其他的任何值時，傳回的值則是一個整數。

例外狀況

SocketException

嘗試存取通訊端時發生錯誤。

-或-

optionName 設定為不支援的值 MaxConnections。

ObjectDisposedException

Socket 已關閉。

範例

下列程式碼範例會擷 LingerOption 取和 Send 逾時值，並將其顯示至主控台。

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.
array<Byte>^ bytes = gcnew array<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(safe_cast<LingerOption^>(s->GetSocketOption(SocketOptionLevel::Socket, SocketOptionName::Linger))->LingerTime.ToString());
s->Close();

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.ASCII.GetString(s.GetSocketOption(SocketOptionLevel.Socket, SocketOptionName.SendTimeout, 4))))
    ' blocks until send returns
    Dim i As Integer = s.Send(msg)

    ' blocks until read returns
    Dim bytes(1024) As Byte
    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 " + CType(s.GetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger), LingerOption).LingerTime.ToString()))
    s.Close()
End Sub

備註

Socket 選項會決定目前 Socket 的行為。使用此多載來取得 Linger 、 AddMembership 和 DropMembership Socket 選項。 Linger針對選項，請使用 Socket 參數 optionLevel 。針對 AddMembership 和 DropMembership ，請使用 IP 。如果您想要設定上述任何選項的值，請使用 SetSocketOption 方法。

注意

在應用程式中啟用網路追蹤時，這個成員會輸出追蹤資訊。如需詳細資訊，請參閱.NET Framework 中的網路追蹤。

另請參閱

適用於

Socket.GetSocketOption 方法

定義

多載

GetSocketOption(SocketOptionLevel, SocketOptionName, Byte[])

參數

例外狀況

範例

備註

另請參閱

適用於

GetSocketOption(SocketOptionLevel, SocketOptionName, Int32)

參數

傳回

例外狀況

範例

備註

另請參閱

適用於

GetSocketOption(SocketOptionLevel, SocketOptionName)

參數

傳回

例外狀況

範例

備註

另請參閱

適用於

意見反應

其他資源