ObjectReferenceTracker.AddReference メソッド

定義

この方法は、参照トラッキングのためにリストへの参照を追加します。

public:
 void AddReference(System::String ^ objectNameOrID, Microsoft::SqlServer::Dts::Runtime::DTSObjectReferenceType refType, int % refListID);
public void AddReference(string objectNameOrID, Microsoft.SqlServer.Dts.Runtime.DTSObjectReferenceType refType, ref int refListID);
member this.AddReference : string * Microsoft.SqlServer.Dts.Runtime.DTSObjectReferenceType * int -> unit
Public Sub AddReference (objectNameOrID As String, refType As DTSObjectReferenceType, ByRef refListID As Integer)

パラメーター

objectNameOrID
String

リストを所有するオブジェクト名またはID(新しい参照)を追跡のために設定します。

refType
DTSObjectReferenceType

追跡したいリファレンスの種類。有効な値は DTSObjectReferenceType 列挙に記載されています。

refListID
Int32

参考文献リストのIDです。

注釈

このメソッドは、 objectNameOrID パラメータで指定されたオブジェクトの参照( refTypeで指定された型)を、与えられた refListIDで参照リストに追加します。 リストを作成するには、 refListIDを0に渡します。 戻ると、 refListID には新たに作成されたリストのIDが含まれ、そのリストには新しいエントリが一つだけ含まれています。 返された refListID は、その後の呼び出しで同じリストへの参照を増やすために使用できます。

この方法は、リファレンストラッカーシステムからリファレンスリスト全体を削除します。 リストを所有するオブジェクトが破棄されるときに呼び出すべきです。 また、リストを所有するオブジェクトがリフレッシュされる際に新しいリストを作成する必要がある場合にも有用です。 例えば、条件分割変換では、出力上の式が変更されると、その式の参照リストを破棄し、新しい式を解析すると新しいリストが作成されます。

refListIDパラメータは、AddReferenceメソッドでリストを新たに生成した際に作成されます。 AddReferenceメソッドはrefListIDを返し、新たに作成されたリストのIDを含みます。 この返 refListID は、同じリストへの参照を追加したり、リストへの参照を削除したり、リストを破棄したり、 SetListInfo メソッドを使う際に利用することができます。

適用対象