WebHeaderCollection.Set Méthode

Référence

Définition

Espace de noms:: System.Net

Assembly:: System.Net.WebHeaderCollection.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.

Affecte la valeur spécifiée à l'en-tête donné.

Surcharges

Set(HttpRequestHeader, String)	Affecte la valeur spécifiée à l'en-tête donné.
Set(HttpResponseHeader, String)	Affecte la valeur spécifiée à l'en-tête donné.
Set(String, String)	Affecte la valeur spécifiée à l'en-tête donné.

Set(HttpRequestHeader, String)

Source:: WebHeaderCollection.cs

Source:: WebHeaderCollection.cs

Source:: WebHeaderCollection.cs

Affecte la valeur spécifiée à l'en-tête donné.

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

public void Set (System.Net.HttpRequestHeader header, 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

Versions .NET Framework et .NET Core 2.0 - 3.1 uniquement : la longueur de value est supérieure à 65 535.

InvalidOperationException

Cette instance WebHeaderCollection 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.

Notes

La longueur de value 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 un ArgumentOutOfRangeException si la longueur de value est supérieure à 65535. Toutes les autres WebHeaderCollection instances acceptent un value de n’importe quelle longueur.
Sur les versions de .NET Core jusqu’à la version 3.1 : une WebHeaderCollection instance utilisée avec n’importe quel en-tête de type HttpResponseHeader lève un ArgumentOutOfRangeException si la longueur de value est supérieure à 65535. Toutes les autres WebHeaderCollection instances acceptent un value de n’importe quelle longueur.
Sur .NET 5 et versions ultérieures : WebHeaderCollection accepte un value de n’importe quelle longueur.

S’applique à

Set(HttpResponseHeader, String)

Source:: WebHeaderCollection.cs

Source:: WebHeaderCollection.cs

Source:: WebHeaderCollection.cs

Affecte la valeur spécifiée à l'en-tête donné.

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

public void Set (System.Net.HttpResponseHeader header, 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

Versions .NET Framework et .NET Core 2.0 - 3.1 uniquement : la longueur de value est supérieure à 65 535.

InvalidOperationException

Cette instance WebHeaderCollection 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.

Notes

La longueur de value 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 un ArgumentOutOfRangeException si la longueur de value est supérieure à 65535. Toutes les autres WebHeaderCollection instances acceptent un value de n’importe quelle longueur.
Sur les versions de .NET Core jusqu’à la version 3.1 : une WebHeaderCollection instance utilisée avec n’importe quel en-tête de type HttpResponseHeader lève un ArgumentOutOfRangeException si la longueur de value est supérieure à 65535. Toutes les autres WebHeaderCollection instances acceptent un value de n’importe quelle longueur.
Sur .NET 5 et versions ultérieures : WebHeaderCollection accepte un value de n’importe quelle longueur.

S’applique à

Set(String, String)

Source:: WebHeaderCollection.cs

Source:: WebHeaderCollection.cs

Source:: WebHeaderCollection.cs

Affecte la valeur spécifiée à l'en-tête donné.

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

public override void Set (string name, 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

Versions .NET Framework et .NET Core 2.0 - 3.1 uniquement : la longueur de value est supérieure à 65 535.

ArgumentException

name est un en-tête restreint.

- ou -

name ou value contient 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 S"www.msn.com".
   HttpWebRequest^ myHttpWebRequest = dynamic_cast<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 = dynamic_cast<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 : {0}", e->Message );
}
catch ( WebException^ e ) 
{
   Console::WriteLine( "WebException is thrown. Message is : {0}", e->Message );
   if ( e->Status == WebExceptionStatus::ProtocolError )
   {
      Console::WriteLine( "Status Code : {0}", (dynamic_cast<HttpWebResponse^>(e->Response))->StatusCode );
      Console::WriteLine( "Status Description : {0}", (dynamic_cast<HttpWebResponse^>(e->Response))->StatusDescription );
      Console::WriteLine( "Server : {0}", (dynamic_cast<HttpWebResponse^>(e->Response))->Server );
   }
}
catch ( Exception^ e ) 
{
   Console::WriteLine( "Exception is thrown. Message is : {0}", e->Message );
}

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

Notes

La longueur de value 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 un ArgumentOutOfRangeException si la longueur de value est supérieure à 65535. Toutes les autres WebHeaderCollection instances acceptent un value de n’importe quelle longueur.
Sur les versions de .NET Core jusqu’à la version 3.1 : une WebHeaderCollection instance utilisée avec n’importe quel en-tête de type HttpResponseHeader lève un ArgumentOutOfRangeException si la longueur de value est supérieure à 65535. Toutes les autres WebHeaderCollection instances acceptent un value de n’importe quelle longueur.
Sur .NET 5 et versions ultérieures : WebHeaderCollection accepte un value de n’importe quelle longueur.

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.

S’applique à

Partager via

WebHeaderCollection.Set Méthode

Définition

Surcharges

Set(HttpRequestHeader, String)

Paramètres

Exceptions

Remarques

S’applique à

Set(HttpResponseHeader, String)

Paramètres

Exceptions

Remarques

S’applique à

Set(String, String)

Paramètres

Exceptions

Exemples

Remarques

S’applique à

Ressources supplémentaires