This topic has not yet been rated - Rate this topic

WebHeaderCollection.IsRestricted Method (String, Boolean)

.NET Framework 4

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

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

static member IsRestricted : 
        headerName:string * 
        response:bool -> bool

Parameters

headerName: Type: System.String
The header to test.

response: Type: System.Boolean
Does the Framework test the response or the request?

Return Value

Type: System.Boolean
true if the header is restricted; otherwise, false.

Exceptions

Exception	Condition
ArgumentNullException	headerName is a null reference (Nothing in Visual Basic) or Empty.
ArgumentException	headerName contains invalid characters.

Remarks

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

Examples

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

C++

No code example is currently available or this language may not be supported.

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Reference

WebHeaderCollection Class

IsRestricted Overload

System.Net Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD