ColorableItem.GetCanonicalName(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.11.40262

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.

Gets the canonical name of a colorable item.

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

 virtual int GetCanonicalName([Runtime::InteropServices::Out] std::wstring const & & name);

public virtual int GetCanonicalName (out string name);

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

Public Overridable Function GetCanonicalName (ByRef name As String) As Integer

Parameters

name: String

[out] A string containing the canonical name of this colorable item.

Returns

Int32

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

Implements

GetCanonicalName(String)

Remarks

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

The base method returns the colorable item's name and a success code of E_NOTIMPL.

Applies to

Share via