ColorableItem.GetCanonicalName(String) Method

Definition

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

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

Implements

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