HttpListenerResponse.AddHeader(String, String) Method

Reference

Definition

Namespace:: System.Net

Assembly:: System.Net.HttpListener.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: HttpListenerResponse.cs

Source:: HttpListenerResponse.cs

Source:: HttpListenerResponse.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Adds the specified header and value to the HTTP headers for this response.

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

public void AddHeader (string name, string value);

member this.AddHeader : string * string -> unit

Public Sub AddHeader (name As String, value As String)

Parameters

name: String

The name of the HTTP header to set.

value: String

The value for the name header.

Exceptions

ArgumentNullException

name is null or an empty string ("").

ArgumentException

You are not allowed to specify a value for the specified header.

-or-

name or value contains invalid characters.

ArgumentOutOfRangeException

.NET Framework and .NET Core versions 2.0 - 3.1 only: The length of value is greater than 65,535 characters.

Examples

The following code example demonstrates adding a header using this property.

public static void SetExpirationDate(long seconds, HttpListenerResponse response)
{
    response.AddHeader("Expires", seconds.ToString());
}

Public Shared Sub SetExpirationDate(ByVal seconds As Long, ByVal response As HttpListenerResponse)
    response.AddHeader("Expires", seconds.ToString())
End Sub

Remarks

Calling this method is equivalent to calling the Set method on the collection returned by the Headers property.

If the header specified in name does not exist, this method inserts a new header into the Headers property's collection. If name is present in the collection, this method replaces the existing value with value. To add a value to an existing header without replacing the existing value, use the AppendHeader method.

Applies to