Task.GetConnectionID Method

Article
12/15/2008

Gets a String containing the ID of the connection.

Espace de noms: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in microsoft.sqlserver.manageddts.dll)

Syntaxe

'Déclaration
Public Function GetConnectionID ( _
    connections As Connections, _
    nameOrID As String _
) As String

public string GetConnectionID (
    Connections connections,
    string nameOrID
)

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

public String GetConnectionID (
    Connections connections, 
    String nameOrID
)

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

Paramètres

connections
The Connections collection to review.

nameOrID
The name of the connection to return.

Valeur de retour

A String containing the connection's ID.

Notes

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

Exemple

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

Sécurité des threads

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.

Plateformes

Plateformes de développement

Pour obtenir la liste des plateformes prises en charge, consultez Configuration matérielle et logicielle requise pour l'installation de SQL Server 2005.

Plateformes cibles