DkmClrObjectFavoritesInfo Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Debugger.Evaluation

Assembly:: Microsoft.VisualStudio.Debugger.Engine.dll

Package:: Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a collection of favorite properties and/or fields on a type as well as auto generated display strings.

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

public ref class DkmClrObjectFavoritesInfo

[System.Runtime.InteropServices.Guid("ce79cfaf-fca4-46ad-3009-41fd2eb09dd7")]
public class DkmClrObjectFavoritesInfo

[<System.Runtime.InteropServices.Guid("ce79cfaf-fca4-46ad-3009-41fd2eb09dd7")>]
type DkmClrObjectFavoritesInfo = class

Public Class DkmClrObjectFavoritesInfo

Inheritance: Object
DkmClrObjectFavoritesInfo

Attributes: GuidAttribute

Properties

DisplayString	[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(). This API was introduced in Visual Studio 16 Update 4 (DkmApiVersion.VS16Update4).
Favorites	The properties and/or fields which are favorites on the target type. This API was introduced in Visual Studio 16 Update 4 (DkmApiVersion.VS16Update4).
Key	A string representing the type which is targeted by this info. This API was introduced in Visual Studio 16 Update 4 (DkmApiVersion.VS16Update4).
SimpleDisplayString	[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(). This API was introduced in Visual Studio 16 Update 4 (DkmApiVersion.VS16Update4).

Methods

Create(String, String, String, ReadOnlyCollection<String>)

Create a new DkmClrObjectFavoritesInfo object instance.