HttpWebResponse.GetResponseHeader Method

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

[Visual Basic]
Public Function GetResponseHeader( _
   ByVal headerName As String _
) As String
[C#]
public string GetResponseHeader(
 string headerName
);
[C++]
public: String* GetResponseHeader(
 String* headerName
);
[JScript]
public function GetResponseHeader(
   headerName : String
) : String;

Parameters

headerName

The header value to return.

Return Value

The contents of the specified header.

Exceptions

Remarks

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

Example

[Visual Basic, C#, C++] 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.

[Visual Basic] 
Public Shared Sub GetPage(url As [String])
Try
        Dim ourUri As New Uri(url)
        ' Creates an HttpWebRequest for the specified URL. 
        Dim myHttpWebRequest As HttpWebRequest = CType(WebRequest.Create(ourUri), HttpWebRequest)
        Dim myHttpWebResponse As HttpWebResponse = CType(myHttpWebRequest.GetResponse(), HttpWebResponse)
        Console.WriteLine(ControlChars.NewLine + "The server did not issue any challenge.  Please try again with a protected resource URL.")
        ' Releases the resources of the response.
        myHttpWebResponse.Close()
    Catch e As WebException
        Dim response As HttpWebResponse = CType(e.Response, HttpWebResponse)
        If Not (response Is Nothing) Then
            If response.StatusCode = HttpStatusCode.Unauthorized Then
                Dim challenge As String = Nothing
                challenge = response.GetResponseHeader("WWW-Authenticate")
                If Not (challenge Is Nothing) Then
                    Console.WriteLine(ControlChars.NewLine + "The following challenge was raised by the server:{0}", challenge)
                End If
            Else
                Console.WriteLine(ControlChars.NewLine + "The following exception was raised : {0}", e.Message)
            End If
        Else
            Console.WriteLine(ControlChars.NewLine + "Response Received from server was null")
        End If 
    Catch e As Exception
        Console.WriteLine(ControlChars.NewLine + "The following exception was raised : {0}", e.Message)
    End Try
End Sub 

[C#] 
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);
     }
 }
}

[C++] 
void GetPage(String* url) {
   try {
      Uri* ourUri = new Uri(url);
      // Creates an HttpWebRequest for the specified URL.
      HttpWebRequest* myHttpWebRequest =
         dynamic_cast<HttpWebRequest*>(WebRequest::Create(ourUri));
      HttpWebResponse* myHttpWebResponse =
         dynamic_cast<HttpWebResponse*>(myHttpWebRequest->GetResponse());
      Console::WriteLine(S"\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 = dynamic_cast<HttpWebResponse*>(e->Response);
      if (response != 0) {
         if (response->StatusCode == HttpStatusCode::Unauthorized) {
            String* challenge = 0;
            challenge= response->GetResponseHeader(S"WWW-Authenticate");
            if (challenge != 0)
               Console::WriteLine(S"\nThe following challenge was raised by the server: {0}",
               challenge);
         } else
            Console::WriteLine(S"\nThe following WebException was raised : {0}",
            e->Message);
      } else
         Console::WriteLine(S"\nResponse Received from server was 0");

   } catch (Exception* e) {
      Console::WriteLine(S"\nThe following Exception was raised : {0}",
         e->Message);
   }
}

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button 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

HttpWebResponse Class | HttpWebResponse Members | System.Net Namespace