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 メソッドは、新しく作成された一覧の ID を含む refListID を返します。 この refListID を後続の呼び出しで使用すると、同じ一覧に別の参照を追加したり、一覧から参照を削除したり、一覧を破棄したりできます。また、SetListInfo メソッドでこのパラメーターを使用することもできます。