Export (0) Print
Expand All

WebHeaderCollection.IsRestricted Method (String, Boolean)

Note: This method is new in the .NET Framework version 2.0.

Tests whether the specified HTTP header can be set for the request or the response.

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

'Declaration
Public Shared Function IsRestricted ( _
	headerName As String, _
	response As Boolean _
) As Boolean
'Usage
Dim headerName As String
Dim response As Boolean
Dim returnValue As Boolean

returnValue = WebHeaderCollection.IsRestricted(headerName, response)
public static boolean IsRestricted (
	String headerName, 
	boolean response
)
public static function IsRestricted (
	headerName : String, 
	response : boolean
) : boolean

Parameters

headerName

The header to test.

response

Does the Framework test the response or the request?

Return Value

true if the header is restricted; otherwise, false.

Exception typeCondition

ArgumentNullException

headerName is a null reference (Nothing in Visual Basic) or Empty.

ArgumentException

headerName contains invalid characters.

The IsRestricted method returns true to indicate that a request or response header is restricted and must be set using properties instead of directly or is set by the system. The restricted headers are:

  • Accept

  • Connection

  • Content-Length

  • Content-Type

  • Date

  • Expect

  • Host

  • If-Modified-Since

  • Range

  • Referer

  • Transfer-Encoding

  • User-Agent

  • Proxy-Connection

The following example checks the IsRestricted property to see if any request headers are prohibited from being set.

Public Shared Sub Main()
Try
        'Create a web request for "www.msn.com".
        Dim myHttpWebRequest As HttpWebRequest = CType(WebRequest.Create("http://www.msn.com"), HttpWebRequest)
        
        'Get the associated response for the above request.
        Dim myHttpWebResponse As HttpWebResponse = CType(myHttpWebRequest.GetResponse(), HttpWebResponse)
        
        'Get the headers associated with the response.
        Dim myWebHeaderCollection As WebHeaderCollection = myHttpWebResponse.Headers
        
        'Check if the first response header is restricted.
    dim i as integer
    for i =0 to myWebHeaderCollection.Count-1
            If WebHeaderCollection.IsRestricted(myWebHeaderCollection.AllKeys(i)) Then
                Console.WriteLine("'{0}' is a restricted header", myWebHeaderCollection.AllKeys(i))
            Else
                Console.WriteLine("'{0}' is not a restricted header", myWebHeaderCollection.AllKeys(i))
            End If 
    next
    myHttpWebResponse.Close()
    Catch e As WebException
        Console.WriteLine(e.Message)
        If e.Status = WebExceptionStatus.ProtocolError Then
            Console.WriteLine("Status Code : {0}", CType(e.Response, HttpWebResponse).StatusCode)
            Console.WriteLine("Status Description : {0}", CType(e.Response, HttpWebResponse).StatusDescription)
            Console.WriteLine("Server : {0}", CType(e.Response, HttpWebResponse).Server)
        End If
    Catch e As Exception
        Console.WriteLine(e.Message)
    End Try
End Sub 'Main

    try {
        // Create a web request for "www.msn.com".
        HttpWebRequest myHttpWebRequest = (HttpWebRequest)(WebRequest.
            Create("http://www.msn.com"));
        // Get the associated response for the above request.
        HttpWebResponse myHttpWebResponse = (HttpWebResponse)(
            myHttpWebRequest.GetResponse());
        // Get the headers associated with the response.
        WebHeaderCollection myWebHeaderCollection =
            myHttpWebResponse.get_Headers();

        for (int i = 0; i < myWebHeaderCollection.get_Count(); i++) {
            // Check if the first response header is restriced.
            if (WebHeaderCollection.IsRestricted(myWebHeaderCollection.
                get_AllKeys()[i])) {
                Console.WriteLine("'{0}' is a restricted header",
                    myWebHeaderCollection.get_AllKeys()[i]);
            }
            else {
                Console.WriteLine("'{0}' is not a restricted header",
                    myWebHeaderCollection.get_AllKeys().get_Item(i));
            }
        }
        myHttpWebResponse.Close();
    }
    catch (WebException e) {
        Console.WriteLine("\nWebException is thrown.\nMessage is:" 
            + e.get_Message());
        if (e.get_Status().Equals(WebExceptionStatus.ProtocolError)) {
            Console.WriteLine("Status Code : {0}", ((HttpWebResponse)(
                e.get_Response())).get_StatusCode());
            Console.WriteLine("Status Description : {0}", ((
                HttpWebResponse)(e.get_Response())).get_StatusDescription());
            Console.WriteLine("Server : {0}", ((HttpWebResponse)(
                e.get_Response())).get_Server());
        }
    }
    catch (System.Exception e) {
        Console.WriteLine("Exception is thrown. Message is :" 
            + e.get_Message());
    }
} //main

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

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

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft