IVsProvideColorableItems.GetColorableItem(Int32, IVsColorableItem) Method

Definition

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

public:
 int GetColorableItem(int iIndex, [Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::IVsColorableItem ^ % ppItem);
public:
 int GetColorableItem(int iIndex, [Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::IVsColorableItem ^ &  ppItem);
int GetColorableItem(int iIndex, [Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::IVsColorableItem const & & ppItem);
public int GetColorableItem (int iIndex, out Microsoft.VisualStudio.TextManager.Interop.IVsColorableItem ppItem);
abstract member GetColorableItem : int * IVsColorableItem -> int
Public Function GetColorableItem (iIndex As Integer, ByRef ppItem As IVsColorableItem) As Integer

Parameters

iIndex
Int32

[in] Integer containing the index value for the custom colorable item. This value is never zero.

ppItem
IVsColorableItem

[out] Custom colorable item object. For more information, see IVsColorableItem.

Returns

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From textmgr.idl:

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.

Applies to