IVsTaskItem2.ImageListIndex Method

Article
03/06/2013

Returns the index into the image list maintained by a provider.

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

Syntax

'Declaration
Function ImageListIndex ( _
    <OutAttribute> ByRef pIndex As Integer _
) As Integer

int ImageListIndex(
    out int pIndex
)

int ImageListIndex(
    [OutAttribute] int% pIndex
)

abstract ImageListIndex : 
        pIndex:int byref -> int

function ImageListIndex(
    pIndex : int
) : int

Parameters

pIndex
Type: System.Int32%
[out, retval] Pointer to the index into the image list.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Implements

IVsTaskItem.ImageListIndex(Int32%)

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsTaskItem::ImageListIndex(
   [out,retval] long *pIndex
);

If you have provided a custom image list to represent a category or subcategory, return the correct index into it. Each task provider can provide one image list using the ImageList. Each task item can then specify an image into this list using the ImageListIndex method. Otherwise, return one of the _vstaskbitmap enumerators to use one of the default bitmaps.

.NET Framework Security

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.

Share via