WebHeaderCollection.Set 方法

参考

定义

命名空间:: System.Net

程序集:: System.Net.WebHeaderCollection.dll

程序集:: System.dll

程序集:: netstandard.dll

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

将指定的标头设置为指定的值。

重载

Set(HttpRequestHeader, String)	将指定的标头设置为指定的值。
Set(HttpResponseHeader, String)	将指定的标头设置为指定的值。
Set(String, String)	将指定的标头设置为指定的值。

Set(HttpRequestHeader, String)

Source:: WebHeaderCollection.cs

Source:: WebHeaderCollection.cs

Source:: WebHeaderCollection.cs

将指定的标头设置为指定的值。

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)

参数

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 版本上：WebHeaderCollection如果的长度value大于 65535，则属性返回Headers的实例将引发 ArgumentOutOfRangeException 。所有其他 WebHeaderCollection 实例都接受 value 任意长度的。
在 .NET Core 版本到版本 3.1：WebHeaderCollection如果的长度大于 65535，则与类型HttpResponseHeader的任何标头一起使用的value实例将引发 ArgumentOutOfRangeException 。所有其他 WebHeaderCollection 实例都接受 value 任意长度的。
在 .NET 5 及更高版本上： WebHeaderCollection 接受 value 任意长度的。

适用于

Set(HttpResponseHeader, String)

Source:: WebHeaderCollection.cs

Source:: WebHeaderCollection.cs

Source:: WebHeaderCollection.cs

将指定的标头设置为指定的值。

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)

参数

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 版本上：WebHeaderCollection如果的长度value大于 65535，则属性返回Headers的实例将引发 ArgumentOutOfRangeException 。所有其他 WebHeaderCollection 实例都接受 value 任意长度的。
在 .NET Core 版本到版本 3.1：WebHeaderCollection如果的长度大于 65535，则与类型HttpResponseHeader的任何标头一起使用的value实例将引发 ArgumentOutOfRangeException 。所有其他 WebHeaderCollection 实例都接受 value 任意长度的。
在 .NET 5 及更高版本上： WebHeaderCollection 接受 value 任意长度的。

适用于

Set(String, String)

Source:: WebHeaderCollection.cs

Source:: WebHeaderCollection.cs

Source:: WebHeaderCollection.cs

将指定的标头设置为指定的值。

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)

参数

name: String

要设置的标头。

value: String

要设置的标头内容。

例外

ArgumentNullException

name 是 null 或 Empty。

ArgumentOutOfRangeException

仅限 .NET Framework 和 .NET Core 2.0 - 3.1 版本：value 的长度大于 65535。

ArgumentException

name 是受限制的标头。

- 或 -

name 或 value 包含无效字符。

示例

以下示例使用 Set 方法设置现有标头的值。

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

注意

的长度 value 仅在 .NET Framework 和 .NET Core 版本 2.0 - 3.1 中验证。

在所有适用的 .NET Framework 版本上：WebHeaderCollection如果的长度value大于 65535，则属性返回Headers的实例将引发 ArgumentOutOfRangeException 。所有其他 WebHeaderCollection 实例都接受 value 任意长度的。
在 .NET Core 版本到版本 3.1：WebHeaderCollection如果的长度大于 65535，则与类型HttpResponseHeader的任何标头一起使用的value实例将引发 ArgumentOutOfRangeException 。所有其他 WebHeaderCollection 实例都接受 value 任意长度的。
在 .NET 5 及更高版本上： WebHeaderCollection 接受 value 任意长度的。

注解

如果标头中指定的标头不存在，该方法会将 Set 新标头插入标头名称/值对列表中。

如果中 header 指定的标头已存在， value 则替换现有值。

适用于

通过

WebHeaderCollection.Set 方法

定义

重载

Set(HttpRequestHeader, String)

参数

例外

注解

适用于

Set(HttpResponseHeader, String)

参数

例外

注解

适用于

Set(String, String)

参数

例外

示例

注解

适用于

其他资源