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

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

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft