Share via


HttpClientConnection.UseProxyCredentials Property

Definition

Gets or sets a Boolean that indicates whether or not the connection will use network credentials.

public:
 property bool UseProxyCredentials { bool get(); void set(bool value); };
public bool UseProxyCredentials { get; set; }
member this.UseProxyCredentials : bool with get, set
Public Property UseProxyCredentials As Boolean

Property Value

A Boolean that indicates if the proxy connection will use network credentials. A value of true indicates that the connection will use network credentials. A value of false indicates that the connection will not use network credentials.

Examples

The following code example creates an HttpClientConnection, then sets the properties. The value of the properties requires replacement with values that are valid for your application.

string[] byPassList = { "http://myserver", "http://companysite" };  
Package pkg = new Package();  
ConnectionManager httpConn = pkg.Connections.Add("HTTP");  
HttpClientConnection clientConn = new HttpClientConnection(httpConn.AcquireConnection(null));  
clientConn.ChunkSize = 5;  // Default is 1.  
clientConn.ProxyBypassList = byPassList;  
clientConn.Timeout = 60;  // Default is 30.  
clientConn.UseSecureConnection = false;  

// When UseServerCredentials is true, provide Domain and Password.  
clientConn.UseServerCredentials = true;  
clientConn.ServerDomain = "serverLogOnDomain";  
clientConn.ServerUserName = "serversUserName";  
clientConn.ServerPassword = "serverPasswd"; // Write-only property.  

// When UseProxyCredentials is true, provide Domain and Password.  
clientConn.UseProxyCredentials = true;  
clientConn.ProxyDomain = "myDomain";  
clientConn.ProxyPassword = "proxyPassword";  
Dim byPassList() As String = {"http://myserver", "http://companysite"}  

Dim pkg As Package =  New Package()   
Dim httpConn As ConnectionManager =  pkg.Connections.Add("HTTP")   
Dim clientConn As HttpClientConnection =  New HttpClientConnection(httpConn.AcquireConnection(Nothing))   
clientConn.ChunkSize = 5  ' Default is 1.  
clientConn.ProxyBypassList = byPassList  
clientConn.Timeout = 60  ' Default is 30.  
clientConn.UseSecureConnection = False  

' When UseServerCredentials is true, provide Domain and Password.  
clientConn.UseServerCredentials = True  
clientConn.ServerDomain = "serverLogOnDomain"  
clientConn.ServerUserName = "serversUserName"  
clientConn.ServerPassword = "serverPasswd" ' Write-only property.  

' When UseProxyCredentials is true, provide Domain and Password.  
clientConn.UseProxyCredentials = True  
clientConn.ProxyDomain = "myDomain"  
clientConn.ProxyPassword = "proxyPassword"  

Remarks

Default value is false.

Applies to