Skip to main content
.NET Framework Class Library
HttpListenerResponse..::.AddHeader Method

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

Namespace: System.Net
Assembly: System (in System.dll)
Syntax
Public Sub AddHeader ( _
	name As String, _
	value As String _
)
public void AddHeader(
	string name,
	string value
)
public:
void AddHeader(
	String^ name, 
	String^ value
)
member AddHeader : 
        name:string * 
        value:string -> unit 

Parameters

name
Type: System..::.String
The name of the HTTP header to set.
value
Type: System..::.String
The value for the name header.
Exceptions
ExceptionCondition
ArgumentNullException

name is nullNothingnullptra null reference (Nothing in Visual Basic) 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

The length of value is greater than 65,535 characters.

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.

Examples

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


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


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

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.