ObjectReferenceTracker.SetListInfo(Int32, String, String) Metodo

Definizione

Spazio dei nomi:

Microsoft.SqlServer.Dts.Runtime

Assembly:

Microsoft.SqlServer.ManagedDTS.dll

Questo metodo consente di fornire metadati per un elenco di riferimenti esistente.

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)

Parametri

refListID

Int32

ID dell'elenco in cui si trova attualmente l'oggetto.

usageLocation

String

Posizione in cui viene utilizzato l'oggetto.

usageDescription

String

Descrizione che spiega la posizione in cui viene utilizzato l'oggetto.

Commenti

Dopo aver creato un nuovo elenco di riferimenti, questo metodo deve essere usato per impostare i metadati iniziali. È improbabile che la usageLocation proprietà cambierà, ma è possibile aggiornare entrambe usageLocation le usageDescription proprietà quanto più spesso necessario.

In usageLocation genere è il nome dell'attività o del componente proprietario dell'elenco. Ciò usageDescription è destinato a fornire descrizioni più dettagliate del modo in cui vengono usati gli oggetti nell'elenco.

Il refListID parametro viene creato quando l'elenco viene appena generato usando il AddReference metodo . Il AddReference metodo restituisce a un refListIDoggetto e contiene l'ID dell'elenco appena creato. Questa restituzione refListID può essere usata nelle chiamate successive per aggiungere altri riferimenti allo stesso elenco, rimuovere riferimenti all'elenco, eliminare un elenco o quando si usa il SetListInfo metodo .