IVsColorableItem.GetDisplayName(String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

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 display name of the custom colorable item.

public:
 int GetDisplayName([Runtime::InteropServices::Out] System::String ^ % pbstrName);

int GetDisplayName([Runtime::InteropServices::Out] std::wstring const & & pbstrName);

public int GetDisplayName (out string pbstrName);

abstract member GetDisplayName : string -> int

Public Function GetDisplayName (ByRef pbstrName As String) As Integer

Parameters

pbstrName: String

[out] Returns a localized string containing the display name for the custom colorable item.

Returns

Int32

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

Remarks

COM Signature

From textmgr.idl:

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.

Applies to

Compartir a través de