Task.GetConnectionName Method

Article
12/03/2008

Gets a String containing the name of the connection.

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

Syntax

'Declaration
Public Function GetConnectionName ( _
    connections As Connections, _
    nameOrID As String _
) As String

public string GetConnectionName (
    Connections connections,
    string nameOrID
)

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

public String GetConnectionName (
    Connections connections, 
    String nameOrID
)

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

Parameters

connections
The Connections collection to review.

nameOrID
The ID of the connection to return.

Return Value

A String containing the connection's name.

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.

Example

The following code example shows an example of a task using 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

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