IVsProvideColorableItems.GetColorableItem Method

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

'宣言
Function GetColorableItem ( _
    iIndex As Integer, _
    <OutAttribute> ByRef ppItem As IVsColorableItem _
) As Integer
'使用
Dim instance As IVsProvideColorableItems
Dim iIndex As Integer
Dim ppItem As IVsColorableItem
Dim returnValue As Integer

returnValue = instance.GetColorableItem(iIndex, _
    ppItem)

int GetColorableItem(
    int iIndex,
    out IVsColorableItem ppItem
)

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

function GetColorableItem(
    iIndex : int, 
    ppItem : IVsColorableItem
) : int

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:

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.

Permissions

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

See Also

Reference

IVsProvideColorableItems Interface

IVsProvideColorableItems Members

Microsoft.VisualStudio.TextManager.Interop Namespace