Share via


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

Définition

Cette méthode vous permet de fournir des métadonnées à une liste de références existante.

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)

Paramètres

refListID
Int32

ID de la liste où figure actuellement l'objet.

usageLocation
String

Emplacement où l'objet est utilisé.

usageDescription
String

Description qui explique à quel emplacement l'objet est utilisé.

Remarques

Une fois qu’une nouvelle liste de références est créée, cette méthode doit être utilisée pour définir les métadonnées initiales. Il est peu probable que la usageLocation propriété change, mais il est possible de mettre à jour à la fois usageLocation et usageDescription les propriétés aussi souvent que nécessaire.

Il usageLocation s’agit généralement du nom de la tâche ou du composant propriétaire de la liste. Ceci usageDescription est destiné à fournir des descriptions plus détaillées de la façon dont les objets de la liste sont utilisés.

Le refListID paramètre est créé lorsque la liste est générée à l’aide de la AddReference méthode. La AddReference méthode vous renvoie un refListID, et elle contient l’ID de la liste nouvellement créée. Cette valeur retournée refListID peut être utilisée dans les appels suivants pour ajouter d’autres références à la même liste, supprimer des références à la liste, détruire une liste ou lors de l’utilisation de la SetListInfo méthode.

S’applique à