IVsCompletionSet.GetImageList Method

Article
03/11/2013

Returns the list of images (glyphs) supported by the completion set.

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

Syntax

'Declaration
Function GetImageList ( _
    <OutAttribute> ByRef phImages As IntPtr _
) As Integer

int GetImageList(
    out IntPtr phImages
)

int GetImageList(
    [OutAttribute] IntPtr% phImages
)

abstract GetImageList : 
        phImages:IntPtr byref -> int

function GetImageList(
    phImages : IntPtr
) : int

Parameters

phImages
Type: System.IntPtr%
[out] Returns a handle to the image list associated with the completion set.

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 IVsCompletionSet::GetImageList(
   [out] HANDLE *phImages
);

This method returns the entire list (as represented by a handle to an image list) of images supported by a completion set. To specify which image is associated with a particular completion set item, return the appropriate image number for the piGlyph parameter in GetDisplayText.

In managed code, the image list is typically contained in an instance of ImageList and the handle can be obtained by accessing the Handle property.

.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