ConnectionManager.AcquireConnection Method (Object)

Article
07/16/2015

Applies To: SQL Server 2016 Preview

Creates an instance of the connection type.

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

Syntax

public object AcquireConnection(
    object txn
)

public:
Object^ AcquireConnection(
    Object^ txn
)

member AcquireConnection : 
        txn:Object -> Object

Public Function AcquireConnection (
    txn As Object
) As Object

Parameters

txn
Type: System.Object

The handle to a transaction type.

Return Value

Type: System.Object

An object that contains the transaction connection.

Remarks

Pass null for the transaction parameter txn when the SupportsDTCTransactions property is false. If the SupportsDTCTransactions property is true, you can pass null in the transaction parameter to indicate that the container supports transactions, but is not going to participate.

Examples

Legacy Code Example

The following code example shows how to add the OLE DB connection to the connection manager and acquire the connection.

// Create the package.
Package pkg = new Package();

// Add a ConnectionManager to the Connections collection.
ConnectionManager connMgr = pkg.Connections.Add("ADO.NET:OLEDB");
connMgr.Properties["RetainSameConnection"].SetValue(connMgr , true);
connMgr.ConnectionString = connStr;

// Aqcuire the connection.
object connection = connMgr.AcquireConnection(null);

' Create the package.
Dim pkg As Package =  New Package() 
 
' Add a ConnectionManager to the Connections collection.
Dim connMgr As ConnectionManager =  pkg.Connections.Add("ADO.NET:OLEDB") 
connMgr.Properties("RetainSameConnection").SetValue(connMgr , True)
connMgr.ConnectionString = connStr
 
' Aqcuire the connection.
Dim connection As Object =  connMgr.AcquireConnection(Nothing)