Compartilhar via


IVsColorableItem.GetDisplayName(String) Method

Definition

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

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