WebHeaderCollection.Set WebHeaderCollection.Set WebHeaderCollection.Set WebHeaderCollection.Set Method

Definition

Sets the specified header to the specified value.

Overloads

Set(HttpRequestHeader, String) Set(HttpRequestHeader, String) Set(HttpRequestHeader, String) Set(HttpRequestHeader, String)

Sets the specified header to the specified value.

Set(HttpResponseHeader, String) Set(HttpResponseHeader, String) Set(HttpResponseHeader, String) Set(HttpResponseHeader, String)

Sets the specified header to the specified value.

Set(String, String) Set(String, String) Set(String, String) Set(String, String)

Sets the specified header to the specified value.

Set(HttpRequestHeader, String) Set(HttpRequestHeader, String) Set(HttpRequestHeader, String) Set(HttpRequestHeader, String)

Sets the specified header to the specified value.

public:
 void Set(System::Net::HttpRequestHeader header, System::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)

Parameters

value
String String String String

The content of the header to set.

Exceptions

Remarks

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.

Set(HttpResponseHeader, String) Set(HttpResponseHeader, String) Set(HttpResponseHeader, String) Set(HttpResponseHeader, String)

Sets the specified header to the specified value.

public:
 void Set(System::Net::HttpResponseHeader header, System::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)

Parameters

value
String String String String

The content of the header to set.

Exceptions

Remarks

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.

Set(String, String) Set(String, String) Set(String, String) Set(String, String)

Sets the specified header to the specified value.

public:
 override void Set(System::String ^ name, System::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)

Parameters

name
String String String String

The header to set.

value
String String String String

The content of the header to set.

Exceptions

name is a restricted header.

-or-

name or value contain invalid characters.

Examples

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

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 'Main

Remarks

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.

Applies to