WebHeaderCollection.Set Method (String, String)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Sets the specified header to the specified value.

Namespace:   System.Net
Assembly:  System (in System.dll)

public override void Set(
	string name,
	string value


Type: System.String

The header to set.

Type: System.String

The content of the header to set.

Exception Condition

name is null or Empty.


The length of value is greater than 65535.


name is a restricted header.


name or value contain invalid characters.

If the header specified in the header does not exist, the Set method inserts a new header into the list of header name/value pairs.

If the header specified in header is already present, value replaces the existing value.

The following example uses the Set method to set the value of an existing header.

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.
// 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);

.NET Framework
Available since 1.1
Return to top