ObjectReferenceTracker.SetListInfo(Int32, String, String) Método

Definição

Namespace:

Microsoft.SqlServer.Dts.Runtime

Assembly:

Microsoft.SqlServer.ManagedDTS.dll

Este método permite que você forneça metadados para uma lista de referências existente.

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)

Parâmetros

refListID

Int32

A ID da lista na qual o objeto está localizado atualmente.

usageLocation

String

O local em que o objeto é usado.

usageDescription

String

Uma descrição que explica onde o objeto está sendo usado.

Comentários

Depois que uma nova lista de referência é criada, esse método deve ser usado para definir os metadados iniciais. É improvável que a usageLocation propriedade seja alterada, mas é possível atualizar as propriedades e usageDescription as usageLocation propriedades sempre que necessário.

Geralmente usageLocation , o nome da tarefa ou componente que possui a lista. Isso usageDescription se destina a fornecer descrições mais detalhadas de como os objetos na lista são usados.

O refListID parâmetro é criado quando a lista é gerada recentemente usando o AddReference método. O AddReference método retorna a você um refListIDe contém a ID da lista recém-criada. Isso retornado refListID pode ser usado em chamadas subsequentes para adicionar mais referências à mesma lista, remover referências à lista, destruir uma lista ou ao usar o SetListInfo método.