Export (0) Print
Expand All

WebHeaderCollection.Set Method (String, String)

Sets the specified header to the specified value.

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

public override void Set (
	string name,
	string value
)
public void Set (
	String name, 
	String value
)
public override function Set (
	name : String, 
	value : String
)
Not applicable.

Parameters

name

The header to set.

value

The content of the header to set.

Exception typeCondition

ArgumentNullException

name is a null reference (Nothing in Visual Basic) or Empty.

ArgumentOutOfRangeException

The length of value is greater than 65535.

ArgumentException

name is a restricted header.

-or-

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

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.
        get_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.get_Message());
}
catch (WebException e) {
    Console.WriteLine("WebException is thrown. Message is :" 
        + e.get_Message());
    if (e.get_Status().Equals(WebExceptionStatus.ProtocolError)) {
        Console.WriteLine("Status Code : {0}", System.Convert.
            ToString(((HttpWebResponse)e.get_Response()).
            get_StatusCode()));
        Console.WriteLine("Status Description : {0}",
            System.Convert.ToString(((HttpWebResponse)e.get_Response()).
            get_StatusDescription()));
        Console.WriteLine("Server : {0}", System.Convert.
            ToString(((HttpWebResponse)e.get_Response()).get_Server()));
    }
}
catch (System.Exception e) {
    Console.WriteLine("Exception is thrown. Message is :" 
        + e.get_Message());
}

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft