WebHeaderCollection.Set Methode

Definition

Namespace:

System.Net

Assemblys:

netstandard.dll, System.Net.WebHeaderCollection.dll

Legt den angegebenen Header auf den angegebenen Wert fest.

Überlädt

Name	Beschreibung
Set(HttpRequestHeader, String)	Legt den angegebenen Header auf den angegebenen Wert fest.
Set(HttpResponseHeader, String)	Legt den angegebenen Header auf den angegebenen Wert fest.
Set(String, String)	Legt den angegebenen Header auf den angegebenen Wert fest.

Set(HttpRequestHeader, String)

Quelle:

WebHeaderCollection.cs

Legt den angegebenen Header auf den angegebenen Wert fest.

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)

Parameter

header

HttpRequestHeader

Der festzulegende HttpRequestHeader-Wert.

value

String

Der Inhalt des festzulegenden Headers.

Ausnahmen

ArgumentOutOfRangeException

Nur .NET Framework und .NET Core, Versionen 2.0-3.1: value ist länger als 65.535 Zeichen.

InvalidOperationException

Diese WebHeaderCollection-Instanz lässt keine Instanzen von HttpRequestHeader zu.

Hinweise

Wenn der im Header angegebene Header nicht vorhanden ist, fügt die Set Methode einen neuen Header in die Liste der Headernamen-Wert-Paare ein.

Wenn der in header angegebene Header bereits vorhanden ist, value ersetzt den vorhandenen Wert.

Hinweis

Die Länge von value wird nur in den .NET Framework- und .NET Core-Versionen 2.0 bis 3.1 überprüft.

• Für alle anwendbaren .NET Framework-Versionen: Eine WebHeaderCollection Von der Headers -Eigenschaft zurückgegebene Instanz löst einen aus ArgumentOutOfRangeException , wenn die Länge von value größer als 65535 ist. Alle anderen WebHeaderCollection Instanzen akzeptieren eine value beliebige Länge.
• In .NET Core-Versionen bis Version 3.1: Eine WebHeaderCollection Instanz, die mit einem beliebigen Header des Typs HttpResponseHeader verwendet wird, löst eine aus ArgumentOutOfRangeException , wenn die Länge von value größer als 65535 ist. Alle anderen WebHeaderCollection Instanzen akzeptieren eine value beliebige Länge.
• Unter .NET 5 und höheren Versionen: WebHeaderCollection akzeptiert eine value beliebige Länge.

Set(HttpResponseHeader, String)

Quelle:

WebHeaderCollection.cs

Legt den angegebenen Header auf den angegebenen Wert fest.

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)

Parameter

header

HttpResponseHeader

Der festzulegende HttpResponseHeader-Wert.

value

String

Der Inhalt des festzulegenden Headers.

Ausnahmen

ArgumentOutOfRangeException

Nur .NET Framework und .NET Core, Versionen 2.0-3.1: value ist länger als 65.535 Zeichen.

InvalidOperationException

Diese WebHeaderCollection-Instanz lässt keine Instanzen von HttpResponseHeader zu.

Hinweise

Wenn der im Header angegebene Header nicht vorhanden ist, fügt die Set Methode einen neuen Header in die Liste der Headernamen-Wert-Paare ein.

Wenn der in header angegebene Header bereits vorhanden ist, value ersetzt den vorhandenen Wert.

Hinweis

Die Länge von value wird nur in den .NET Framework- und .NET Core-Versionen 2.0 bis 3.1 überprüft.

• Für alle anwendbaren .NET Framework-Versionen: Eine WebHeaderCollection Von der Headers -Eigenschaft zurückgegebene Instanz löst einen aus ArgumentOutOfRangeException , wenn die Länge von value größer als 65535 ist. Alle anderen WebHeaderCollection Instanzen akzeptieren eine value beliebige Länge.
• In .NET Core-Versionen bis Version 3.1: Eine WebHeaderCollection Instanz, die mit einem beliebigen Header des Typs HttpResponseHeader verwendet wird, löst eine aus ArgumentOutOfRangeException , wenn die Länge von value größer als 65535 ist. Alle anderen WebHeaderCollection Instanzen akzeptieren eine value beliebige Länge.
• Unter .NET 5 und höheren Versionen: WebHeaderCollection akzeptiert eine value beliebige Länge.

Set(String, String)

Quelle:

WebHeaderCollection.cs

Legt den angegebenen Header auf den angegebenen Wert fest.

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)

Parameter

name

String

Der festzulegende Header.

value

String

Der Inhalt des festzulegenden Headers.

Ausnahmen

ArgumentNullException

name ist null oder Empty.

ArgumentOutOfRangeException

Nur .NET Framework und .NET Core, Versionen 2.0-3.1: value ist länger als 65.535 Zeichen.

ArgumentException

name ist ein eingeschränkter Header.

- oder -

name oder value enthält ungültige Zeichen.

Beispiele

Im folgenden Beispiel wird die Set -Methode verwendet, um den Wert eines vorhandenen Headers festzulegen.

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

Hinweis

Die Länge von value wird nur in den .NET Framework- und .NET Core-Versionen 2.0 bis 3.1 überprüft.

• Für alle anwendbaren .NET Framework-Versionen: Eine WebHeaderCollection Von der Headers -Eigenschaft zurückgegebene Instanz löst einen aus ArgumentOutOfRangeException , wenn die Länge von value größer als 65535 ist. Alle anderen WebHeaderCollection Instanzen akzeptieren eine value beliebige Länge.
• In .NET Core-Versionen bis Version 3.1: Eine WebHeaderCollection Instanz, die mit einem beliebigen Header des Typs HttpResponseHeader verwendet wird, löst eine aus ArgumentOutOfRangeException , wenn die Länge von value größer als 65535 ist. Alle anderen WebHeaderCollection Instanzen akzeptieren eine value beliebige Länge.
• Unter .NET 5 und höheren Versionen: WebHeaderCollection akzeptiert eine value beliebige Länge.

Hinweise

Wenn der im Header angegebene Header nicht vorhanden ist, fügt die Set Methode einen neuen Header in die Liste der Headernamen-Wert-Paare ein.

Wenn der in header angegebene Header bereits vorhanden ist, value ersetzt den vorhandenen Wert.