IVsColorableItem::GetDefaultColors Method (array<COLORINDEX>^, array<COLORINDEX>^)

Visual Studio 2015

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

C++

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

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:

C++

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.