HttpWebResponse.GetResponseHeader Method (String)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

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

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

Public Function GetResponseHeader (
	headerName As String
) As String


Type: System.String

The header value to return.

Return Value

Type: System.String

The contents of the specified header.

Exception Condition

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])
           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.
       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
                   Console.WriteLine(ControlChars.NewLine + "The following exception was raised : {0}", e.Message)
               End If
               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 

.NET Framework
Available since 1.1
Return to top