IVsColorableItem.GetDefaultColors Method

Article
05/06/2010

Defines the default background and foreground colors for a custom colorable item.

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

Syntax

'Déclaration
Function GetDefaultColors ( _
    <OutAttribute> piForeground As COLORINDEX(), _
    <OutAttribute> piBackground As COLORINDEX() _
) As Integer
'Utilisation
Dim instance As IVsColorableItem
Dim piForeground As COLORINDEX()
Dim piBackground As COLORINDEX()
Dim returnValue As Integer

returnValue = instance.GetDefaultColors(piForeground, _
    piBackground)

int GetDefaultColors(
    COLORINDEX[] piForeground,
    COLORINDEX[] piBackground
)

int GetDefaultColors(
    [OutAttribute] array<COLORINDEX>^ piForeground, 
    [OutAttribute] array<COLORINDEX>^ piBackground
)

abstract GetDefaultColors : 
        piForeground:COLORINDEX[] byref * 
        piBackground:COLORINDEX[] byref -> int

function GetDefaultColors(
    piForeground : COLORINDEX[], 
    piBackground : COLORINDEX[]
) : int

Parameters

piForeground
Type: array<Microsoft.VisualStudio.TextManager.Interop.COLORINDEX[]
[out] Returns an integer containing the foreground color. For more information, see COLORINDEX

piBackground
Type: array<Microsoft.VisualStudio.TextManager.Interop.COLORINDEX[]
[out] Returns an integer containing the background color. For more information, see COLORINDEX

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::GetDefaultColors(
   [out] COLORINDEX *piForeground,
   [out] COLORINDEX *piBackground
);

The color values returned are taken from the COLORINDEX enumeration and are essentially indices into a predefined color list.

.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.