ColorableItem.GetDescription(String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Package

Assembly:: Microsoft.VisualStudio.Package.LanguageService.14.0.dll

Assembly:: Microsoft.VisualStudio.Package.LanguageService.15.0.dll

Package:: Microsoft.VisualStudio.Package.LanguageService.15.0 v17.12.40392

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.

Returns a description for this colorable item.

public:
 virtual int GetDescription([Runtime::InteropServices::Out] System::String ^ % desc);

 virtual int GetDescription([Runtime::InteropServices::Out] std::wstring const & & desc);

public virtual int GetDescription (out string desc);

abstract member GetDescription : string -> int
override this.GetDescription : string -> int

Public Overridable Function GetDescription (ByRef desc As String) As Integer

Parameters

desc: String

[out] A string containing a description.

Returns

Int32

If successful, returns S_OK; otherwise, returns an error code.

Implements

GetDescription(String)

Remarks

This method is an implementation of the GetDescription method in the IVsMergeableUIItem interface.

The base method returns a null value for the description (the core text editor does not use this value) and a success code of E_NOTIMPL.

Applies to

Partilhar via