Export (0) Print
Expand All

WebProxy.IsBypassed Method

Indicates whether to use the proxy server for the specified host.

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

public bool IsBypassed(
	Uri host
)

Parameters

host
Type: System.Uri

The Uri instance of the host to check for proxy use.

Return Value

Type: System.Boolean
true if the proxy server should not be used for host; otherwise, false.

Implements

IWebProxy.IsBypassed(Uri)

ExceptionCondition
ArgumentNullException

The host parameter is null.

The IsBypassed method is used to determine whether to bypass the proxy server when accessing an Internet resource.

The BypassProxyOnLocal and BypassList properties control the return value of the IsBypassed method.

IsBypassed returns true under any of the following conditions:

  • If BypassProxyOnLocal is true and host is a local URI. Local requests are identified by the lack of a period (.) in the URI, as in "http://webserver/".

  • If host matches a regular expression in BypassList.

  • If Address is null.

All other conditions return false.

The following code example creates a WebProxy object and calls this method to check whether the bypass list is properly set.

public static WebProxy CreateProxyAndCheckBypass(bool bypassLocal)
{
    // Do not use the proxy server for Contoso.com URIs. 
    string[] bypassList = new string[]{";*.Contoso.com"};
    WebProxy proxy =  new WebProxy("http://contoso", 
        bypassLocal, 
        bypassList);

    // Test the bypass list. 
    if (!proxy.IsBypassed(new Uri("http://www.Contoso.com")))
    {
        Console.WriteLine("Bypass not working!");
        return null;
    } 
    else 
    {
        Console.WriteLine("Bypass is working.");
        return proxy;
    }
}

.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