Socket.GetSocketOption Méthode

Référence

Définition

Espace de noms:: System.Net.Sockets

Assembly:: System.Net.Sockets.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Retourne la valeur d'une option Socket.

Surcharges

GetSocketOption(SocketOptionLevel, SocketOptionName, Byte[])	Retourne la valeur de l'option Socket spécifiée sous la forme d'un tableau d'octets.
GetSocketOption(SocketOptionLevel, SocketOptionName, Int32)	Retourne la valeur de l'option Socket spécifiée dans un tableau.
GetSocketOption(SocketOptionLevel, SocketOptionName)	Retourne la valeur d'une option Socket spécifiée, représentée sous la forme d'un objet.

GetSocketOption(SocketOptionLevel, SocketOptionName, Byte[])

Source:: Socket.cs

Source:: Socket.cs

Source:: Socket.cs

Retourne la valeur de l'option Socket spécifiée sous la forme d'un tableau d'octets.

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())

Paramètres

optionLevel: SocketOptionLevel

Une des valeurs de l'objet SocketOptionLevel.

optionName: SocketOptionName

Une des valeurs de l'objet SocketOptionName.

optionValue: Byte[]

Tableau de type Byte devant recevoir la valeur de l'option.

Exceptions

SocketException

Une erreur s’est produite pendant la tentative d’accès au socket.

- ou -

Dans les applications .NET Compact Framework, l'espace de mémoire tampon par défaut de Windows CE est de 32 768 octets. Vous pouvez modifier l'espace de mémoire tampon de chaque socket en appelant SetSocketOption.

ObjectDisposedException

Socket a été fermé.

Exemples

L’exemple de code suivant récupère les valeurs et Send de LingerOption délai d’attente et les affiche dans la console.

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

Remarques

Socket les options déterminent le comportement du actuel Socket. Une fois cette méthode terminée, le tableau spécifié par le optionValue paramètre contient la valeur de l’option spécifiée Socket .

Lorsque la longueur du optionValue tableau est inférieure au nombre d’octets requis pour stocker la valeur de l’option spécifiée Socket , GetSocketOption lève un SocketException. Si vous recevez un SocketException, utilisez la SocketException.ErrorCode propriété pour obtenir le code d’erreur spécifique. Une fois ce code obtenu, reportez-vous à la documentation du code d’erreur de l’API Windows Sockets version 2 pour obtenir une description détaillée de l’erreur. Utilisez cette surcharge pour tous les sockets représentés par des valeurs booléennes ou des entiers.

Notes

Ce membre génère des informations de traçage lorsque vous activez le traçage réseau dans votre application. Pour plus d’informations, consultez Suivi réseau dans .NET Framework.

Voir aussi

S’applique à

GetSocketOption(SocketOptionLevel, SocketOptionName, Int32)

Source:: Socket.cs

Source:: Socket.cs

Source:: Socket.cs

Retourne la valeur de l'option Socket spécifiée dans un tableau.

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()

Paramètres

optionLevel: SocketOptionLevel

Une des valeurs de l'objet SocketOptionLevel.

optionName: SocketOptionName

Une des valeurs de l'objet SocketOptionName.

optionLength: Int32

Longueur (en octets) de la valeur de retour attendue.

Retours

Byte[]

Tableau de type Byte contenant la valeur de l'option de socket.

Exceptions

SocketException

Une erreur s’est produite pendant la tentative d’accès au socket.

- ou -

ObjectDisposedException

Socket a été fermé.

Exemples

L’exemple de code suivant récupère les valeurs et Send de LingerOption délai d’attente et les affiche dans la console.

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

Remarques

Le optionLength paramètre définit la taille maximale du tableau d’octets retourné. Si la valeur de l’option nécessite moins d’octets, le tableau ne contient que ce nombre d’octets. Si la valeur de l’option nécessite plus d’octets, GetSocketOption lève un SocketException. Utilisez cette surcharge pour tous les sockets représentés par des valeurs booléennes ou des entiers.

Notes

Si vous recevez un SocketException, utilisez la SocketException.ErrorCode propriété pour obtenir le code d’erreur spécifique. Une fois ce code obtenu, reportez-vous à la documentation du code d’erreur de l’API Windows Sockets version 2 pour obtenir une description détaillée de l’erreur.

Notes

Ce membre génère des informations de traçage lorsque vous activez le traçage réseau dans votre application. Pour plus d’informations, consultez Suivi réseau dans .NET Framework.

Voir aussi

S’applique à

GetSocketOption(SocketOptionLevel, SocketOptionName)

Source:: Socket.cs

Source:: Socket.cs

Source:: Socket.cs

Retourne la valeur d'une option Socket spécifiée, représentée sous la forme d'un objet.

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

Paramètres

optionLevel: SocketOptionLevel

Une des valeurs de l'objet SocketOptionLevel.

optionName: SocketOptionName

Une des valeurs de l'objet SocketOptionName.

Retours

Object

Objet représentant la valeur de l'option. Si le paramètre optionName a la valeur du champ Linger, la valeur de retour est une instance de la classe LingerOption. Si optionName a la valeur du champ AddMembership ou DropMembership, la valeur de retour est une instance de la classe MulticastOption. Si optionName a une autre valeur, la valeur de retour est un entier.

Exceptions

SocketException

Une erreur s’est produite pendant la tentative d’accès au socket.

- ou -

optionName avait la valeur MaxConnections non prise en charge.

ObjectDisposedException

Socket a été fermé.

Exemples

L’exemple de code suivant récupère les valeurs et Send de LingerOption délai d’attente et les affiche dans la console.

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

Remarques

Socket les options déterminent le comportement du actuel Socket. Utilisez cette surcharge pour obtenir les Lingeroptions , AddMembershipet DropMembership Socket . Pour l’option Linger , utilisez Socket pour le optionLevel paramètre . Pour AddMembership et DropMembership, utilisez IP. Si vous souhaitez définir la valeur de l’une des options répertoriées ci-dessus, utilisez la SetSocketOption méthode .

Notes

Ce membre génère des informations de traçage lorsque vous activez le traçage réseau dans votre application. Pour plus d’informations, consultez Suivi réseau dans .NET Framework.

Voir aussi

S’applique à

Partager via

Socket.GetSocketOption Méthode

Définition

Surcharges

GetSocketOption(SocketOptionLevel, SocketOptionName, Byte[])

Paramètres

Exceptions

Exemples

Remarques

Voir aussi

S’applique à

GetSocketOption(SocketOptionLevel, SocketOptionName, Int32)

Paramètres

Retours

Exceptions

Exemples

Remarques

Voir aussi

S’applique à

GetSocketOption(SocketOptionLevel, SocketOptionName)

Paramètres

Retours

Exceptions

Exemples

Remarques

Voir aussi

S’applique à

Ressources supplémentaires