Export (0) Print
Expand All

WebResponse.Headers Property

When overridden in a derived class, gets a collection of header name-value pairs associated with this request.

[Visual Basic]
Public Overridable ReadOnly Property Headers As WebHeaderCollection
[C#]
public virtual WebHeaderCollection Headers {get;}
[C++]
public: __property virtual WebHeaderCollection* get_Headers();
[JScript]
public function get Headers() : WebHeaderCollection;

Property Value

An instance of the WebHeaderCollection class containing header values associated with this response.

Exceptions

Exception Type Condition
NotSupportedException Any attempt is made to get or set the property, when the property is not overridden in a descendant class.

Remarks

The Headers property contains the name-value header pairs returned in the response.

Note   The WebResponse class is an abstract (MustInherit in Visual Basic) class. The actual behavior of WebResponse instances at run time is determined by the descendant class returned by WebRequest.GetResponse. For more information about default values and exceptions, please see the documentation for the descendant classes, such as HttpWebResponse and FileWebResponse.

Example

[Visual Basic, C#, C++] The following example displays all of the header name-value pairs returned in the WebResponse.

[Visual Basic] 

' Create a 'WebRequest' object with the specified url     
Dim myWebRequest As WebRequest = WebRequest.Create("www.contoso.com")

' Send the 'WebRequest' and wait for response.
Dim myWebResponse As WebResponse = myWebRequest.GetResponse()

' Display all the Headers present in the response received from the URl.
Console.WriteLine(ControlChars.Cr + "The following headers were received in the response")

' Headers property is a 'WebHeaderCollection'. Use it's properties to traverse the collection and display each header
Dim i As Integer

While i < myWebResponse.Headers.Count
    Console.WriteLine(ControlChars.Cr + "Header Name:{0}, Header value :{1}", myWebResponse.Headers.Keys(i), myWebResponse.Headers(i))
        i = i + 1
End While

' Release resources of response object.
myWebResponse.Close()


[C#] 

          // Create a 'WebRequest' object with the specified url.     
         WebRequest myWebRequest = WebRequest.Create("http://www.contoso.com"); 

         // Send the 'WebRequest' and wait for response.
      WebResponse myWebResponse = myWebRequest.GetResponse(); 

         // Display all the Headers present in the response received from the URl.
         Console.WriteLine("\nThe following headers were received in the response");

      // Display each header and it's key , associated with the response object.
         for(int i=0; i < myWebResponse.Headers.Count; ++i)  
            Console.WriteLine("\nHeader Name:{0}, Header value :{1}",myWebResponse.Headers.Keys[i],myWebResponse.Headers[i]); 

         // Release resources of response object.
         myWebResponse.Close(); 
         

[C++] 
// Create a 'WebRequest' object with the specified url.
WebRequest* myWebRequest = WebRequest::Create(S"http://www.contoso.com");

// Send the 'WebRequest' and wait for response.
WebResponse* myWebResponse = myWebRequest->GetResponse();

// Display all the Headers present in the response received from the URl.
Console::WriteLine(S"\nThe following headers were received in the response");

// Display each header and its key , associated with the response object.
for (int i = 0 ; i < myWebResponse->Headers->Count ; ++i)
   Console::WriteLine(S"\nHeader Name: {0}, Header value : {1}",
   myWebResponse->Headers->Keys->Item[i], myWebResponse->Headers->Item[i]);

// Release resources of response object.
myWebResponse->Close();

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework, Common Language Infrastructure (CLI) Standard

See Also

WebResponse Class | WebResponse Members | System.Net Namespace | WebHeaderCollection | HttpWebResponse.Headers

Show:
© 2014 Microsoft