IVsColorableItem::GetDisplayName Method (String^)

Visual Studio 2015

Gets the display name of the custom colorable item.

Namespace: Microsoft.VisualStudio.TextManager.Interop
Assembly: Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)

Syntax

C++

int GetDisplayName(
	[OutAttribute] String^% pbstrName
)

Parameters

pbstrName: Type: System::String^
[out] Returns a localized string containing the display name for the custom colorable item.

Return Value

Type: System::Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From textmgr.idl:

C++

HRESULT IVsColorableItem::GetDisplayName(
   [out] BSTR * pbstrName
);

The display name is used in the in the Options dialog box for customization of colors, as well as comparison in inter-language merging of colorable items. This name is also used to track any user customizations of a particular colorable item. See Custom Colorable Items for details.