IVsColorableItem.GetDisplayName Method

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

'Déclaration
Function GetDisplayName ( _
    <OutAttribute> ByRef pbstrName As String _
) As Integer

int GetDisplayName(
    out string pbstrName
)

int GetDisplayName(
    [OutAttribute] String^% pbstrName
)

abstract GetDisplayName : 
        pbstrName:string byref -> int 

function GetDisplayName(
    pbstrName : String
) : int

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:

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.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

IVsColorableItem Interface

Microsoft.VisualStudio.TextManager.Interop Namespace

Other Resources

Custom Colorable Items