ColorableItem::GetDescription Method (String^)

Visual Studio 2015

Visual Studio 2013
Visual Studio 2012
Visual Studio 2010
Visual Studio 2008
Visual Studio 2005

Returns a description for this colorable item.

Namespace: Microsoft.VisualStudio.Package
Assembly: Microsoft.VisualStudio.Package.LanguageService.14.0 (in Microsoft.VisualStudio.Package.LanguageService.14.0.dll)

Syntax

C++

public:
virtual int GetDescription(
	[OutAttribute] String^% desc
)

Parameters

desc: Type: System::String^
[out] A string containing a description.

Return Value

Type: System::Int32

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

Implements

IVsMergeableUIItem::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.