IVsProvideColorableItems::GetColorableItem Method (Int32, IVsColorableItem^)

Visual Studio 2015

Determines the item information for each custom colorable item proffered by the language service.

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

Syntax

C++

int GetColorableItem(
	int iIndex,
	[OutAttribute] IVsColorableItem^% ppItem
)

Parameters

iIndex: Type: System::Int32
[in] Integer containing the index value for the custom colorable item. This value is never zero.

ppItem: Type: Microsoft.VisualStudio.TextManager.Interop::IVsColorableItem^
[out] Custom colorable item object. For more information, see IVsColorableItem.

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 IVsProvideColorableItems::GetColorableItem(
   [in] int iIndex, 
   [out] IVsColorableItem **ppItem
);

An index value of 0 is never seen by this method as that colorable item represents the default text color, which Visual Studio handles automatically.