This topic has not yet been rated - Rate this topic

Task.GetConnectionID Method

SQL Server 2012

SQL Server 2005

Gets a String containing the ID of the connection.

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

Syntax

C++

JScript

public string GetConnectionID(
	Connections connections,
	string nameOrID
)

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.

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);}
    }

Reference

Task Class

Microsoft.SqlServer.Dts.Runtime Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD