• [アーティクル]

AddReference メソッド

このメソッドは、参照追跡一覧に参照を追加します。

名前空間:  Microsoft.SqlServer.Dts.Runtime
アセンブリ:  Microsoft.SqlServer.ManagedDTS (Microsoft.SqlServer.ManagedDTS.dll)

構文

'宣言
Public Sub AddReference ( _
    objectNameOrID As String, _
    refType As DTSObjectReferenceType, _
    ByRef refListID As Integer _
)
'使用
Dim instance As ObjectReferenceTracker
Dim objectNameOrID As String
Dim refType As DTSObjectReferenceType
Dim refListID As Integer

instance.AddReference(objectNameOrID, _
    refType, refListID)

public void AddReference(
    string objectNameOrID,
    DTSObjectReferenceType refType,
    ref int refListID
)

public:
void AddReference(
    String^ objectNameOrID, 
    DTSObjectReferenceType refType, 
    int% refListID
)

member AddReference : 
        objectNameOrID:string * 
        refType:DTSObjectReferenceType * 
        refListID:int byref -> unit 

public function AddReference(
    objectNameOrID : String, 
    refType : DTSObjectReferenceType, 
    refListID : int
)

パラメーター

  • objectNameOrID
    型: System. . :: . .String
    一覧を所有するオブジェクトの名前または ID です。追跡する新しい参照は、この一覧に追加します。

説明

このメソッドは、objectNameOrID パラメータで指定した名前のオブジェクトの参照を、指定した refListID で参照一覧に追加します。この参照の種類は refType で指定します。一覧を作成する場合は、refListID に 0 を渡します。このメソッドが値を返す際に、新しく作成された一覧の ID が refListID に格納されます。この一覧には新しいエントリが 1 つ含まれます。返された refListID を後続の呼び出しで使用することにより、同じ一覧に別の参照を追加できます。

このメソッドは、参照トラッカ システムから参照リスト全体を削除します。一覧を所有するオブジェクトが破棄される際に、このメソッドを呼び出す必要があります。一覧を所有するオブジェクトが更新され、新しい一覧の作成が必要である場合にも、このメソッドが役立ちます。たとえば、条件分割変換で出力時の式が変更された場合に、この式の参照一覧を破棄し、新しい式を解析して新しい一覧を作成できます。

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