Export (0) Print
Expand All

Task.GetConnectionID Method

Gets a String containing the ID of the connection.

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

Public Function GetConnectionID ( _
	connections As Connections, _
	nameOrID As String _
) As String
Dim instance As Task 
Dim connections As Connections 
Dim nameOrID As String 
Dim returnValue As String 

returnValue = instance.GetConnectionID(connections, _


Type: Microsoft.SqlServer.Dts.Runtime.Connections
The Connections collection to review.
Type: String
The name of the connection to return.

Return Value

Type: String
A String containing the connection's ID.

This function is useful when if you are writing a custom task, and want to convert between the connection ID and the connection name.

The following code example shows an example of a task that uses the GetConnectionID method to get and set the names and ID of the connection in the task's custom myConnection property.

Public Property myConnection() As String
              Return GetConnectionName(m_connections, m_ MyConnectionName)
  End Get
  Set (ByVal Value As String) 
              m_MyConnectionName = GetConnectionID(m_connections, value)
  End Set
End Property

Community Additions

© 2014 Microsoft