WebHeaderCollection.Set Méthode

Définition

Espace de noms:

System.Net

Assemblys:

netstandard.dll, System.Net.WebHeaderCollection.dll

Définit l’en-tête spécifié sur la valeur spécifiée.

Surcharges

Nom	Description
Set(HttpRequestHeader, String)	Définit l’en-tête spécifié sur la valeur spécifiée.
Set(HttpResponseHeader, String)	Définit l’en-tête spécifié sur la valeur spécifiée.
Set(String, String)	Définit l’en-tête spécifié sur la valeur spécifiée.

Set(HttpRequestHeader, String)

Source:

WebHeaderCollection.cs

Définit l’en-tête spécifié sur la valeur spécifiée.

public:
 void Set(System::Net::HttpRequestHeader header, System::String ^ value);

public void Set(System.Net.HttpRequestHeader header, string? value);

override this.Set : System.Net.HttpRequestHeader * string -> unit

Public Sub Set (header As HttpRequestHeader, value As String)

Paramètres

header

HttpRequestHeader

Valeur HttpRequestHeader à définir.

value

String

Contenu de l’en-tête à définir.

Exceptions

ArgumentOutOfRangeException

.NET Framework et .NET Core versions 2.0 - 3.1 uniquement : la longueur est value supérieure à 65535.

InvalidOperationException

Cette WebHeaderCollection instance n’autorise pas les instances de HttpRequestHeader.

Remarques

Si l’en-tête spécifié dans l’en-tête n’existe pas, la Set méthode insère un nouvel en-tête dans la liste des paires nom/valeur d’en-tête.

Si l’en-tête spécifié dans header est déjà présent, value remplace la valeur existante.

Note

La longueur est value validée uniquement dans .NET Framework et .NET Core versions 2.0 - 3.1.

• Sur toutes les versions de .NET Framework applicables : une WebHeaderCollection instance retournée par la Headers propriété lève une ArgumentOutOfRangeException valeur si la longueur est value supérieure à 65535. Toutes les autres WebHeaderCollection instances acceptent une value longueur quelconque.
• Sur les versions de .NET Core via la version 3.1 : une WebHeaderCollection instance utilisée avec un en-tête de type HttpResponseHeader lève une ArgumentOutOfRangeException valeur si la longueur est value supérieure à 65535. Toutes les autres WebHeaderCollection instances acceptent une value longueur quelconque.
• Sur .NET 5 et versions ultérieures : WebHeaderCollection accepte une value longueur quelconque.

Set(HttpResponseHeader, String)

Source:

WebHeaderCollection.cs

Définit l’en-tête spécifié sur la valeur spécifiée.

public:
 void Set(System::Net::HttpResponseHeader header, System::String ^ value);

public void Set(System.Net.HttpResponseHeader header, string? value);

override this.Set : System.Net.HttpResponseHeader * string -> unit

Public Sub Set (header As HttpResponseHeader, value As String)

Paramètres

header

HttpResponseHeader

Valeur HttpResponseHeader à définir.

value

String

Contenu de l’en-tête à définir.

Exceptions

ArgumentOutOfRangeException

.NET Framework et .NET Core versions 2.0 - 3.1 uniquement : la longueur est value supérieure à 65535.

InvalidOperationException

Cette WebHeaderCollection instance n’autorise pas les instances de HttpResponseHeader.

Remarques

Si l’en-tête spécifié dans l’en-tête n’existe pas, la Set méthode insère un nouvel en-tête dans la liste des paires nom/valeur d’en-tête.

Si l’en-tête spécifié dans header est déjà présent, value remplace la valeur existante.

Note

La longueur est value validée uniquement dans .NET Framework et .NET Core versions 2.0 - 3.1.

• Sur toutes les versions de .NET Framework applicables : une WebHeaderCollection instance retournée par la Headers propriété lève une ArgumentOutOfRangeException valeur si la longueur est value supérieure à 65535. Toutes les autres WebHeaderCollection instances acceptent une value longueur quelconque.
• Sur les versions de .NET Core via la version 3.1 : une WebHeaderCollection instance utilisée avec un en-tête de type HttpResponseHeader lève une ArgumentOutOfRangeException valeur si la longueur est value supérieure à 65535. Toutes les autres WebHeaderCollection instances acceptent une value longueur quelconque.
• Sur .NET 5 et versions ultérieures : WebHeaderCollection accepte une value longueur quelconque.

Set(String, String)

Source:

WebHeaderCollection.cs

Définit l’en-tête spécifié sur la valeur spécifiée.

public:
 override void Set(System::String ^ name, System::String ^ value);

public override void Set(string name, string? value);

override this.Set : string * string -> unit

Public Overrides Sub Set (name As String, value As String)

Paramètres

name

String

En-tête à définir.

value

String

Contenu de l’en-tête à définir.

Exceptions

ArgumentNullException

name est null ou Empty.

ArgumentOutOfRangeException

.NET Framework et .NET Core versions 2.0 - 3.1 uniquement : la longueur est value supérieure à 65535.

ArgumentException

name est un en-tête restreint.

- ou -

name ou value contiennent des caractères non valides.

Exemples

L’exemple suivant utilise la Set méthode pour définir la valeur d’un en-tête existant.

try {
    // Create a web request for "www.msn.com".
    HttpWebRequest myHttpWebRequest = (HttpWebRequest) WebRequest.Create("http://www.msn.com");

    // Get the headers associated with the request.
    WebHeaderCollection myWebHeaderCollection = myHttpWebRequest.Headers;

    // Set the Cache-Control header in the request.
    myWebHeaderCollection.Set("Cache-Control", "no-cache");

    // Get the associated response for the above request.
    HttpWebResponse myHttpWebResponse = (HttpWebResponse) myHttpWebRequest.GetResponse();

    Console.WriteLine ("Headers after 'Set' method is used on Cache-Control :");
    // Print the headers for the request.
    PrintHeaders(myWebHeaderCollection);
    myHttpWebResponse.Close();
}
// Catch exception if trying to set a restricted header.
catch(ArgumentException e) {
    Console.WriteLine("ArgumentException is thrown. Message is :" + e.Message);
}
catch(WebException e) {
    Console.WriteLine("WebException is thrown. Message is :" + e.Message);
    if(e.Status == WebExceptionStatus.ProtocolError) {
        Console.WriteLine("Status Code : {0}", ((HttpWebResponse)e.Response).StatusCode);
        Console.WriteLine("Status Description : {0}", ((HttpWebResponse)e.Response).StatusDescription);
        Console.WriteLine("Server : {0}", ((HttpWebResponse)e.Response).Server);
    }
}
catch(Exception e) {
    Console.WriteLine("Exception is thrown. Message is :" + e.Message);
}

Public Shared Sub Main()

Try
        'Create a web request for "www.msn.com".
        Dim myHttpWebRequest As HttpWebRequest = CType(WebRequest.Create("http://www.msn.com"), HttpWebRequest)
        
        'Get the headers associated with the request.
        Dim myWebHeaderCollection As WebHeaderCollection = myHttpWebRequest.Headers
        
        'Set the Cache-Control header in the request.
        myWebHeaderCollection.Set("Cache-Control", "no-cache")

        'Get the associated response for the above request.
        Dim myHttpWebResponse As HttpWebResponse = CType(myHttpWebRequest.GetResponse(), HttpWebResponse)
        
    Console.WriteLine ("Headers after 'Set' method is used on Cache-Control :")
        'Print the headers for the request.
        PrintHeaders(myWebHeaderCollection)
        myHttpWebResponse.Close()
   'Catch exception if trying to set a restricted header.
    Catch e As ArgumentException
        Console.WriteLine(e.Message)
    Catch e As WebException
        Console.WriteLine(e.Message)
        If e.Status = WebExceptionStatus.ProtocolError Then
            Console.WriteLine("Status Code : {0}", CType(e.Response, HttpWebResponse).StatusCode)
            Console.WriteLine("Status Description : {0}", CType(e.Response, HttpWebResponse).StatusDescription)
            Console.WriteLine("Server : {0}", CType(e.Response, HttpWebResponse).Server)
        End If
    Catch e As Exception
        Console.WriteLine(e.Message)
    End Try
End Sub

Note

La longueur est value validée uniquement dans .NET Framework et .NET Core versions 2.0 - 3.1.

• Sur toutes les versions de .NET Framework applicables : une WebHeaderCollection instance retournée par la Headers propriété lève une ArgumentOutOfRangeException valeur si la longueur est value supérieure à 65535. Toutes les autres WebHeaderCollection instances acceptent une value longueur quelconque.
• Sur les versions de .NET Core via la version 3.1 : une WebHeaderCollection instance utilisée avec un en-tête de type HttpResponseHeader lève une ArgumentOutOfRangeException valeur si la longueur est value supérieure à 65535. Toutes les autres WebHeaderCollection instances acceptent une value longueur quelconque.
• Sur .NET 5 et versions ultérieures : WebHeaderCollection accepte une value longueur quelconque.

Remarques

Si l’en-tête spécifié dans l’en-tête n’existe pas, la Set méthode insère un nouvel en-tête dans la liste des paires nom/valeur d’en-tête.

Si l’en-tête spécifié dans header est déjà présent, value remplace la valeur existante.