WebHeaderCollection.Add Méthode

Définition

Espace de noms:

System.Net

Assemblys:

netstandard.dll, System.Net.WebHeaderCollection.dll

Insère un nouvel en-tête dans la collection.

Surcharges

Nom	Description
Add(String)	Insère l’en-tête spécifié dans la collection.
Add(HttpRequestHeader, String)	Insère l’en-tête spécifié avec la valeur spécifiée dans la collection.
Add(HttpResponseHeader, String)	Insère l’en-tête spécifié avec la valeur spécifiée dans la collection.
Add(String, String)	Insère un en-tête portant le nom et la valeur spécifiés dans la collection.

Add(String)

Source:

WebHeaderCollection.cs

Insère l’en-tête spécifié dans la collection.

public:
 void Add(System::String ^ header);

public void Add(string header);

override this.Add : string -> unit

Public Sub Add (header As String)

Paramètres

header

String

En-tête à ajouter, avec le nom et la valeur séparés par un signe deux-points.

Exceptions

ArgumentNullException

header est null ou Empty.

ArgumentException

header ne contient pas de deux-points (:) caractère.

- ou -

La longueur de la partie valeur de header est supérieure à 65535.

- ou -

La partie nom de l’élément header est Empty ou contient des caractères non valides.

- ou -

header est un en-tête restreint qui doit être défini avec une propriété.

- ou -

La partie valeur de contient des header caractères non valides.

ArgumentOutOfRangeException

.NET Framework et .NET Core versions 2.0 - 3.1 uniquement : longueur de la chaîne après le signe deux-points (:) est supérieur à 65535.

Exemples

L’exemple suivant ajoute une paire nom/valeur à une WebHeaderCollection utilisation de la Add méthode.

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;

    Console.WriteLine("Configuring Webrequest to accept Danish and English language using 'Add' method");

    //Add the Accept-Language header (for Danish) in the request.
    myWebHeaderCollection.Add("Accept-Language:da");

    //Include English in the Accept-Langauge header. 
    myWebHeaderCollection.Add("Accept-Language","en;q=0.8");

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

    //Print the headers for the request.
    printHeaders(myWebHeaderCollection);
    myHttpWebResponse.Close();
}
//Catch exception if trying to add a restricted header.
catch(ArgumentException e) {
    Console.WriteLine(e.Message);
}
catch(WebException e) {
    Console.WriteLine("\nWebException is thrown. \nMessage 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
        
    Console.WriteLine("Configuring Webrequest to accept Danish and English language using 'Add' method")
        
    'Add the Accept-Language header (for Danish) in the request.
        myWebHeaderCollection.Add("Accept-Language:da")
        
        'Include English in the Accept-Langauge header. 
        myWebHeaderCollection.Add("Accept-Language","en;q" + ChrW(61) + "0.8")
        
        'Get the associated response for the above request.
        Dim myHttpWebResponse As HttpWebResponse = CType(myHttpWebRequest.GetResponse(), HttpWebResponse)
        
        'Print the headers for the request.
        printHeaders(myWebHeaderCollection)
        myHttpWebResponse.Close()
    'Catch exception if trying to add 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

Longueur de la partie valeur de header, autrement dit, la chaîne après le signe deux-points (:), est 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 de la partie valeur est header supérieure à 65535. Toutes les autres WebHeaderCollection instances acceptent une valeur de toute longueur.
• Sur les versions de .NET Core par le biais de 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 de la partie valeur est header supérieure à 65535. Toutes les autres WebHeaderCollection instances acceptent une valeur de toute longueur.
• Sur .NET 5 et versions ultérieures : WebHeaderCollection accepte une valeur de toute longueur.

Remarques

Le header paramètre doit être spécifié au format « name :value ». Si l’en-tête spécifié n’existe pas dans la collection, un nouvel en-tête est ajouté à la collection.

Si l’en-tête spécifié dans header la collection est déjà présent, la partie valeur du header fichier est concaténée avec la valeur existante.

Add(HttpRequestHeader, String)

Source:

WebHeaderCollection.cs

Insère l’en-tête spécifié avec la valeur spécifiée dans la collection.

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

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

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

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

Paramètres

header

HttpRequestHeader

En-tête à ajouter à la collection.

value

String

Contenu de l’en-tête.

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é n’existe pas, la Add 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é est déjà présent, value est ajouté à la liste séparée par des virgules des valeurs associées à l’en-tête.

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.

Add(HttpResponseHeader, String)

Source:

WebHeaderCollection.cs

Insère l’en-tête spécifié avec la valeur spécifiée dans la collection.

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

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

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

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

Paramètres

header

HttpResponseHeader

En-tête à ajouter à la collection.

value

String

Contenu de l’en-tête.

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é n’existe pas, la Add 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é est déjà présent, value est ajouté à la liste séparée par des virgules des valeurs associées à l’en-tête.

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.

Add(String, String)

Source:

WebHeaderCollection.cs

Insère un en-tête portant le nom et la valeur spécifiés dans la collection.

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

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

override this.Add : string * string -> unit

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

Paramètres

name

String

En-tête à ajouter à la collection.

value

String

Contenu de l’en-tête.

Exceptions

ArgumentException

name est null, Emptyou contient des caractères non valides.

- ou -

name est un en-tête restreint qui doit être défini avec un paramètre de propriété.

- ou -

value contient des caractères non valides.

ArgumentOutOfRangeException

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

Exemples

L’exemple suivant ajoute une paire nom/valeur à une WebHeaderCollection utilisation de la Add méthode.

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;

    Console.WriteLine("Configuring Webrequest to accept Danish and English language using 'Add' method");

    //Add the Accept-Language header (for Danish) in the request.
    myWebHeaderCollection.Add("Accept-Language:da");

    //Include English in the Accept-Langauge header. 
    myWebHeaderCollection.Add("Accept-Language","en;q=0.8");

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

    //Print the headers for the request.
    printHeaders(myWebHeaderCollection);
    myHttpWebResponse.Close();
}
//Catch exception if trying to add a restricted header.
catch(ArgumentException e) {
    Console.WriteLine(e.Message);
}
catch(WebException e) {
    Console.WriteLine("\nWebException is thrown. \nMessage 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
        
    Console.WriteLine("Configuring Webrequest to accept Danish and English language using 'Add' method")
        
    'Add the Accept-Language header (for Danish) in the request.
        myWebHeaderCollection.Add("Accept-Language:da")
        
        'Include English in the Accept-Langauge header. 
        myWebHeaderCollection.Add("Accept-Language","en;q" + ChrW(61) + "0.8")
        
        'Get the associated response for the above request.
        Dim myHttpWebResponse As HttpWebResponse = CType(myHttpWebRequest.GetResponse(), HttpWebResponse)
        
        'Print the headers for the request.
        printHeaders(myWebHeaderCollection)
        myHttpWebResponse.Close()
    'Catch exception if trying to add 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 name n’existe pas, la Add 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 name est déjà présent, value est ajouté à la liste de valeurs séparées par des virgules existantes associée name.