WebProxy.UseDefaultCredentials Property

Reference

Definition

Namespace:: System.Net

Assembly:: System.Net.WebProxy.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: WebProxy.cs

Source:: WebProxy.cs

Source:: WebProxy.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets a Boolean value that controls whether the DefaultCredentials are sent with requests.

public:
 property bool UseDefaultCredentials { bool get(); void set(bool value); };

public bool UseDefaultCredentials { get; set; }

member this.UseDefaultCredentials : bool with get, set

Public Property UseDefaultCredentials As Boolean

Property Value

Boolean

true if the default credentials are used; otherwise, false. The default value is false.

Exceptions

InvalidOperationException

You attempted to set this property when the Credentials property contains credentials other than the default credentials.

Remarks

Set this property to true when requests made by this WebProxy object should, if requested by the server, be authenticated using the credentials of the currently logged on user. For client applications, this is the desired behavior in most scenarios. For middle tier applications, such as ASP.NET applications, instead of using this property, you would typically set the Credentials property to the credentials of the client on whose behalf the request is made.

The following table shows the effect of setting the UseDefaultCredentials value, based on the value of the Credentials property.

Credentials value	UseDefaultCredentials value	Effect
DefaultCredentials	`true`	No effect.
DefaultCredentials	`false`	Credentials is set to `null`.
`null`	`true`	Credentials is set to DefaultCredentials.
Any value other than DefaultCredentials or `null`	`true` or `false`	Setting UseDefaultCredentials throws an exception.

If UseDefaultCredentials is false, you can change the Credentials property to any credentials. If UseDefaultCredentials is true, changing the Credentials property from DefaultCredentials (the value that is set when the UseDefaultCredentials property is set to true) will throw an exception.

Applies to