HttpClientConnection.UseServerCredentials Property

Article
12/03/2008

Gets or sets a Boolean that indicates whether the connection uses network credentials.

Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in microsoft.sqlserver.manageddts.dll)

Syntax

'Declaration
Public Property UseServerCredentials As Boolean

public bool UseServerCredentials { get; set; }

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

/** @property */
public boolean get_UseServerCredentials ()

/** @property */
public void set_UseServerCredentials (boolean value)

public function get UseServerCredentials () : boolean

public function set UseServerCredentials (value : boolean)

Property Value

Returns a Boolean that indicates whether the connection will use network credentials. A value of true indicates that network credentials are used.

Remarks

Default value is false.

Example

The following code example creates an HttpClientConnection, then sets the properties. The value of the properties require replacment 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"

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms