DkmClrObjectFavoritesInfo.Create(String, String, String, ReadOnlyCollection<String>) Method

Definition

Create a new DkmClrObjectFavoritesInfo object instance.

This API was introduced in Visual Studio 16 Update 4 (DkmApiVersion.VS16Update4).

public:
 static Microsoft::VisualStudio::Debugger::Evaluation::DkmClrObjectFavoritesInfo ^ Create(System::String ^ Key, System::String ^ DisplayString, System::String ^ SimpleDisplayString, System::Collections::ObjectModel::ReadOnlyCollection<System::String ^> ^ Favorites);
public static Microsoft.VisualStudio.Debugger.Evaluation.DkmClrObjectFavoritesInfo Create (string Key, string DisplayString, string SimpleDisplayString, System.Collections.ObjectModel.ReadOnlyCollection<string> Favorites);
static member Create : string * string * string * System.Collections.ObjectModel.ReadOnlyCollection<string> -> Microsoft.VisualStudio.Debugger.Evaluation.DkmClrObjectFavoritesInfo
Public Shared Function Create (Key As String, DisplayString As String, SimpleDisplayString As String, Favorites As ReadOnlyCollection(Of String)) As DkmClrObjectFavoritesInfo

Parameters

Key
String

[In] A string representing the type which is targeted by this info.

DisplayString
String

[In,Optional] The display string for the target type, this is created and updated automatically by the IDkmClrObjectFavoritesCache when favorites are added or removed. This value is optional when sent to IDkmClrObjectFavoritesCache.UpdateFavorites(). It should always be present in values returned from IDkmClrObjectFavoritesCacheCallback.GetFavorites().

SimpleDisplayString
String

[In,Optional] The simple display string for the target type which does not include field names. This value is optional when sent to IDkmClrObjectFavoritesCache.UpdateFavorites(). It should always be present in values returned from IDkmClrObjectFavoritesCacheCallback.GetFavorites().

Favorites
ReadOnlyCollection<String>

[In] The properties and/or fields which are favorites on the target type.

Returns

DkmClrObjectFavoritesInfo

[Out] Result of this method call.

Applies to