Export (0) Print
Expand All

HttpWebResponse.GetResponseHeader Method

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

Namespace:  System.Net
Assembly:  System (in System.dll)

'Declaration
Public Function GetResponseHeader ( _
	headerName As String _
) As String
'Usage
Dim instance As HttpWebResponse 
Dim headerName As String 
Dim returnValue As String 

returnValue = instance.GetResponseHeader(headerName)

Parameters

headerName
Type: System.String

The header value to return.

Return Value

Type: System.String
The contents of the specified header.

ExceptionCondition
ObjectDisposedException

The current instance has been disposed.

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

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 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
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);
   }
}

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

Community Additions

ADD
Show:
© 2015 Microsoft