ColorableItem.GetCanonicalName Method

Gets the canonical name of a colorable item.

Namespace:  Microsoft.VisualStudio.Package
Assemblies:   Microsoft.VisualStudio.Package.LanguageService.10.0 (in Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
  Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)
  Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)

Syntax

'Declaration
Public Overridable Function GetCanonicalName ( _
    <OutAttribute> ByRef name As String _
) As Integer
public virtual int GetCanonicalName(
    out string name
)
public:
virtual int GetCanonicalName(
    [OutAttribute] String^% name
)
abstract GetCanonicalName : 
        name:string byref -> int 
override GetCanonicalName : 
        name:string byref -> int 
public function GetCanonicalName(
    name : String
) : int

Parameters

  • name
    Type: System.String%
    [out] A string containing the canonical name of this colorable item.

Return Value

Type: System.Int32
If successful, returns S_OK; otherwise, returns an error code.

Implements

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

.NET Framework Security

See Also

Reference

ColorableItem Class

Microsoft.VisualStudio.Package Namespace