Task.GetConnectionID(Connections, String) 方法

定义

获取包含连接的 ID 的字符串。

public:
 System::String ^ GetConnectionID(Microsoft::SqlServer::Dts::Runtime::Connections ^ connections, System::String ^ nameOrID);
public string GetConnectionID (Microsoft.SqlServer.Dts.Runtime.Connections connections, string nameOrID);
member this.GetConnectionID : Microsoft.SqlServer.Dts.Runtime.Connections * string -> string
Public Function GetConnectionID (connections As Connections, nameOrID As String) As String

参数

connections
Connections

要审核的 Connections 集合。

nameOrID
String

要返回的连接的名称。

返回

String

一个包含连接 ID 的字符串。

示例

下面的代码示例演示了一个任务示例,该任务使用 GetConnectionID 方法获取并设置任务自定义属性中的连接的名称和 ID myConnection

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  

注解

如果要编写自定义任务,并想要在连接 ID 和连接名称之间进行转换,此函数很有用。

适用于