WebHeaderCollection.Set Метод

Определение

Пространство имен:

System.Net

Сборки:

netstandard.dll, System.Net.WebHeaderCollection.dll

Задает указанный заголовок указанному значению.

Перегрузки

Имя	Описание
Set(HttpRequestHeader, String)	Задает указанный заголовок указанному значению.
Set(HttpResponseHeader, String)	Задает указанный заголовок указанному значению.
Set(String, String)	Задает указанный заголовок указанному значению.

Set(HttpRequestHeader, String)

Исходный код:

WebHeaderCollection.cs

Задает указанный заголовок указанному значению.

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)

Параметры

header

HttpRequestHeader

Значение HttpRequestHeader , которое нужно задать.

value

String

Содержимое заданного заголовка.

Исключения

ArgumentOutOfRangeException

Только .NET Framework и .NET Core версии 2.0 – 3.1: длина value превышает 65535.

InvalidOperationException

Этот WebHeaderCollection экземпляр не разрешает экземпляры HttpRequestHeader.

Комментарии

Если заголовок, указанный в заголовке, не существует, Set метод вставляет новый заголовок в список пар "имя-значение".

Если заголовок, указанный в header уже присутствует, value заменит существующее значение.

Замечание

Длина value проверяется только в .NET Framework и .NET Core версии 2.0 – 3.1.

• Во всех применимых версиях .NET Framework: экземпляр, возвращаемый Headers свойством, WebHeaderCollection вызывает ArgumentOutOfRangeException исключение, если длина value превышает 65535. Все остальные WebHeaderCollection экземпляры принимают value любую длину.
• В версиях .NET Core до версии 3.1: WebHeaderCollection экземпляр, используемый с любым заголовком типа HttpResponseHeader , создает ArgumentOutOfRangeException исключение, если длина value превышает 65535. Все остальные WebHeaderCollection экземпляры принимают value любую длину.
• В .NET 5 и более поздних версиях: WebHeaderCollection принимает любую длину value .

Set(HttpResponseHeader, String)

Исходный код:

WebHeaderCollection.cs

Задает указанный заголовок указанному значению.

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)

Параметры

header

HttpResponseHeader

Значение HttpResponseHeader , которое нужно задать.

value

String

Содержимое заданного заголовка.

Исключения

ArgumentOutOfRangeException

Только .NET Framework и .NET Core версии 2.0 – 3.1: длина value превышает 65535.

InvalidOperationException

Этот WebHeaderCollection экземпляр не разрешает экземпляры HttpResponseHeader.

Комментарии

Если заголовок, указанный в заголовке, не существует, Set метод вставляет новый заголовок в список пар "имя-значение".

Если заголовок, указанный в header уже присутствует, value заменит существующее значение.

Замечание

Длина value проверяется только в .NET Framework и .NET Core версии 2.0 – 3.1.

• Во всех применимых версиях .NET Framework: экземпляр, возвращаемый Headers свойством, WebHeaderCollection вызывает ArgumentOutOfRangeException исключение, если длина value превышает 65535. Все остальные WebHeaderCollection экземпляры принимают value любую длину.
• В версиях .NET Core до версии 3.1: WebHeaderCollection экземпляр, используемый с любым заголовком типа HttpResponseHeader , создает ArgumentOutOfRangeException исключение, если длина value превышает 65535. Все остальные WebHeaderCollection экземпляры принимают value любую длину.
• В .NET 5 и более поздних версиях: WebHeaderCollection принимает любую длину value .

Set(String, String)

Исходный код:

WebHeaderCollection.cs

Задает указанный заголовок указанному значению.

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)

Параметры

name

String

Заголовок, заданный.

value

String

Содержимое заданного заголовка.

Исключения

ArgumentNullException

name is null или Empty.

ArgumentOutOfRangeException

Только .NET Framework и .NET Core версии 2.0 – 3.1: длина value превышает 65535.

ArgumentException

name — это ограниченный заголовок.

–или–

name или value содержит недопустимые символы.

Примеры

В следующем примере метод используется Set для задания значения существующего заголовка.

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

Замечание

Длина value проверяется только в .NET Framework и .NET Core версии 2.0 – 3.1.

• Во всех применимых версиях .NET Framework: экземпляр, возвращаемый Headers свойством, WebHeaderCollection вызывает ArgumentOutOfRangeException исключение, если длина value превышает 65535. Все остальные WebHeaderCollection экземпляры принимают value любую длину.
• В версиях .NET Core до версии 3.1: WebHeaderCollection экземпляр, используемый с любым заголовком типа HttpResponseHeader , создает ArgumentOutOfRangeException исключение, если длина value превышает 65535. Все остальные WebHeaderCollection экземпляры принимают value любую длину.
• В .NET 5 и более поздних версиях: WebHeaderCollection принимает любую длину value .

Комментарии

Если заголовок, указанный в заголовке, не существует, Set метод вставляет новый заголовок в список пар "имя-значение".

Если заголовок, указанный в header уже присутствует, value заменит существующее значение.