• Article

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)

Syntax

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

returnValue = instance.GetConnectionID(connections, _
    nameOrID)

public string GetConnectionID(
    Connections connections,
    string nameOrID
)

public:
String^ GetConnectionID(
    Connections^ connections, 
    String^ nameOrID
)

member GetConnectionID : 
        connections:Connections * 
        nameOrID:string -> string 

public function GetConnectionID(
    connections : Connections, 
    nameOrID : String
) : String

Parameters

  • nameOrID
    Type: System.String
    The name of the connection to return.

Return Value

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

Remarks

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

Examples

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 string myConnection 
  {
      get
          {return GetConnectionName(m_connections, m_ MyConnectionName);
          }
      set
          {m_MyConnectionName = GetConnectionID(m_connections, value);}
    }

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