IVsProvideColorableItems.GetColorableItem(Int32, IVsColorableItem) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

Int32

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