ObjectReferenceTracker.SetListInfo(Int32, String, String) メソッド

定義

この方法により、既存の参考文献リストのメタデータを提供できます。

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)

パラメーター

refListID
Int32

オブジェクトが現在所在しているリストID。

usageLocation
String

その物体が使われる場所。

usageDescription
String

その物体がどこで使われているかを説明する説明。

注釈

新しい参照リストが作成された後は、この方法で初期メタデータを設定する必要があります。 usageLocationプロパティが変更される可能性は低いですが、必要に応じて頻繁に更新usageLocationおよびusageDescriptionプロパティを更新することは可能です。

usageLocationは通常、リストを所有するタスクやコンポーネントの名前です。 この usageDescription は、リスト内のオブジェクトがどのように使われているかをより詳細に説明することを目的としています。

refListIDパラメータは、AddReferenceメソッドでリストを新たに生成した際に作成されます。 AddReferenceメソッドはrefListIDを返し、新たに作成されたリストのIDを含みます。 この返 refListID は、同じリストへの参照を追加したり、リストへの参照を削除したり、リストを破棄したり、 SetListInfo メソッドを使う際に利用することができます。

適用対象