ObjectReferenceTracker.SetListInfo(Int32, String, String) 方法

定义

命名空间:

Microsoft.SqlServer.Dts.Runtime

程序集:

Microsoft.SqlServer.ManagedDTS.dll

此方法允许您为现有的引用列表提供元数据。

public:
 void SetListInfo(int refListID, System::String ^ usageLocation, System::String ^ usageDescription);

public void SetListInfo (int refListID, string usageLocation, string usageDescription);

member this.SetListInfo : int * string * string -> unit

Public Sub SetListInfo (refListID As Integer, usageLocation As String, usageDescription As String)

参数

refListID

Int32

当前在其中找到此对象的列表 ID。

usageLocation

String

使用对象的位置。

usageDescription

String

解释正在何处使用此对象的说明。

注解

创建新的引用列表后，此方法应用于设置初始元数据。 属性 usageLocation 不太可能更改，但尽可能频繁地更新 usageLocation 属性 usageDescription 。

通常是 usageLocation 拥有列表的任务或组件的名称。 这 usageDescription 旨在更详细地说明如何使用列表中的对象。

refListID使用AddReference该方法新生成列表时，将创建该参数。 该方法 AddReference 返回给你一个 refListID，它包含新创建的列表的 ID。 此返回 refListID 可用于后续调用，以添加对同一列表的更多引用、删除对列表的引用、销毁列表或使用该方法时 SetListInfo 。