ObjectReferenceTracker.RemoveReference Method

Removes a reference from an existing list.

Namespace:  Microsoft.SqlServer.Dts.Runtime
Assembly:  Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)

Syntax

'Declaration
Public Sub RemoveReference ( _
    objectNameOrID As String, _
    refType As DTSObjectReferenceType, _
    ByRef refListID As Integer _
)
'Usage
Dim instance As ObjectReferenceTracker
Dim objectNameOrID As String
Dim refType As DTSObjectReferenceType
Dim refListID As Integer

instance.RemoveReference(objectNameOrID, _
    refType, refListID)
public void RemoveReference(
    string objectNameOrID,
    DTSObjectReferenceType refType,
    ref int refListID
)
public:
void RemoveReference(
    String^ objectNameOrID, 
    DTSObjectReferenceType refType, 
    int% refListID
)
member RemoveReference : 
        objectNameOrID:string * 
        refType:DTSObjectReferenceType * 
        refListID:int byref -> unit 
public function RemoveReference(
    objectNameOrID : String, 
    refType : DTSObjectReferenceType, 
    refListID : int
)

Parameters

  • objectNameOrID
    Type: System.String
    The object name or ID to remove from the tracking list.
  • refListID
    Type: System.Int32%
    The list ID in which the object to remove is currently located.

Remarks

Use this method to remove a reference from an existing list when that object is no longer being used or has been destroyed.

The refListID parameter is created when the list is newly generated using the AddReference method. The AddReference method returns to you a refListID, and it contains the ID of the newly created list. This returned refListID can be used in subsequent calls to add more references to the same list, remove references to the list, destroy a list, or when using the SetListInfo method.