Task.GetConnectionID Method (Connections, String)

 

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

Parameters

connections
Type: Microsoft.SqlServer.Dts.Runtime.Connections

The Connections collection to review.

nameOrID
Type: System.String

The name of the connection to return.

Return Value

Type: System.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
  Get 
              Return GetConnectionName(m_connections, m_ MyConnectionName)
  End Get
  Set (ByVal Value As String) 
              m_MyConnectionName = GetConnectionID(m_connections, value)
  End Set
End Property
Return to top
Show: