ObjectReferenceTracker.SetListInfo Method

Article
12/03/2008

This method allows you to provide metadata for an existing reference list.

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

Syntax

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

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

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

public void SetListInfo (
    int refListID, 
    String usageLocation, 
    String usageDescription
)

public function SetListInfo (
    refListID : int, 
    usageLocation : String, 
    usageDescription : String
)

Parameters

refListID
The list ID in which the object is currently located.

usageLocation
The location where the object is used.

usageDescription
A description that explains where the object is being used.

Remarks

After a new reference list is created, this method should be used to set the initial metadata. It is unlikely that the usageLocation property will change, but it possible to update both usageLocation and usageDescription properties as often as necessary.

The usageLocation is usually the name of the task or component that owns the list. This usageDescription is intended to give more detailed descriptions of how the objects in the list are used.

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.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Share via