IWebProxy.IsBypassed(Uri) Method

Definition

Indicates that the proxy should not be used for the specified host.

C#
public bool IsBypassed(Uri host);

Parameters

host
Uri

The Uri of the host to check for proxy use.

Returns

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

Examples

The following example uses the IsBypassed property to determine whether the proxy server should be used for the specified host.

C#
WebProxy_Interface webProxy_Interface = new WebProxy_Interface(new Uri("http://proxy.example.com"));

webProxy_Interface.Credentials = new NetworkCredential("myusername", "mypassword");

Uri testUri = new Uri("http://www.contoso.com");

// Determine whether the Web proxy can be bypassed for the site "http://www.contoso.com".
if(webProxy_Interface.IsBypassed(testUri))
{
    Console.WriteLine("Web Proxy is by passed");
}
else
{
    Uri? webProxyServer = webProxy_Interface.GetProxy(testUri);
    // In general, we wouldn't expect the condition (`webProxyServer! == testUri`) true here, if  IsBypassed returns `false`.
    // However, technically our interface can allow that.
    if (webProxyServer is null || webProxyServer! == testUri)
    {
        Console.WriteLine("Web proxy is bypassed");
    }
    else
    {
        Console.WriteLine("Web proxy is not bypassed");
        Console.WriteLine($"The web proxy is: {webProxyServer!}");
    }
}

Remarks

The IsBypassed method indicates whether to use the proxy server to access the host that is specified in the host parameter. If IsBypassed returns true, the proxy is not used to contact the host and the request is passed directly to the server. Getting false from IsBypassed does not guarantee that the URI is proxied; you still need to call the GetProxy method to determine this.

Applies to

Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0