WebResponse.Headers Property

Reference

Definition

Namespace:: System.Net

Assemblies:: System.dll, System.Net.Requests.dll

Assemblies:: netstandard.dll, System.Net.Requests.dll

Assembly:: System.Net.Requests.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: WebResponse.cs

Source:: WebResponse.cs

Source:: WebResponse.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 virtual property System::Net::WebHeaderCollection ^ Headers { System::Net::WebHeaderCollection ^ get(); };

public virtual System.Net.WebHeaderCollection Headers { get; }

member this.Headers : System.Net.WebHeaderCollection

Public Overridable ReadOnly Property Headers As WebHeaderCollection

Property Value

WebHeaderCollection

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

Exceptions

NotSupportedException

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

Examples

The following example displays all of the header name-value pairs returned in the WebResponse.

// 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 its 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();


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


    ' 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()

Remarks

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

Note

The WebResponse class is an abstract 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.

Applies to

Product	Versions
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0, 2.1
UWP	10.0

Share via