HttpWebResponse.GetResponseHeader(String) Method

Definition

Gets the contents of a header that was returned with the response.

public string GetResponseHeader (string headerName);

Parameters

headerName
String

The header value to return.

Returns

The contents of the specified header.

Exceptions

The current instance has been disposed.

Examples

This example creates a Web request and queries for a response. If the site requires authentication, this example will respond with a challenge string. This string is extracted using GetResponseHeader.

   public static void GetPage(String url)
    {
    try
            {	
                Uri ourUri = new Uri(url);
                // Creates an HttpWebRequest for the specified URL.
                HttpWebRequest myHttpWebRequest = (HttpWebRequest)WebRequest.Create(ourUri);
                HttpWebResponse myHttpWebResponse = (HttpWebResponse)myHttpWebRequest.GetResponse();
                Console.WriteLine("\nThe server did not issue any challenge.  Please try again with a protected resource URL.");
                // Releases the resources of the response.
                myHttpWebResponse.Close();
            }
        catch(WebException e)
           {
                HttpWebResponse response = (HttpWebResponse)e.Response;
                if (response != null)
                {
                    if (response.StatusCode == HttpStatusCode.Unauthorized)
                    {
                        string challenge = null;
                        challenge= response.GetResponseHeader("WWW-Authenticate");
                        if (challenge != null)
                            Console.WriteLine("\nThe following challenge was raised by the server:{0}",challenge);
                    }
                    else
                {
                    Console.WriteLine("\nThe following WebException was raised : {0}",e.Message);
                }
            }
                else
            {
                Console.WriteLine("\nResponse Received from server was null");
            }
        }
        catch(Exception e)
        {
            Console.WriteLine("\nThe following Exception was raised : {0}",e.Message);
        }
    }
}

Remarks

Use GetResponseHeader to retrieve the contents of particular headers. You must specify which header you want to return.

Applies to

Product Versions
.NET 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