Partager via


IVsSccGlyphs.GetCustomGlyphList Method

Called by the IDE to get a custom glyph image list for source control status.

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

Syntax

'Declaration
Function GetCustomGlyphList ( _
    BaseIndex As UInteger, _
    <OutAttribute> ByRef pdwImageListHandle As UInteger _
) As Integer
int GetCustomGlyphList(
    uint BaseIndex,
    out uint pdwImageListHandle
)
int GetCustomGlyphList(
    [InAttribute] unsigned int BaseIndex, 
    [OutAttribute] unsigned int% pdwImageListHandle
)
abstract GetCustomGlyphList : 
        BaseIndex:uint32 * 
        pdwImageListHandle:uint32 byref -> int
function GetCustomGlyphList(
    BaseIndex : uint, 
    pdwImageListHandle : uint
) : int

Parameters

  • BaseIndex
    Type: UInt32

    [in] Value to add when returning glyph index.

  • pdwImageListHandle
    Type: UInt32%

    [out] Handle to the custom image list.

Return Value

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

Remarks

COM Signature

From ivssccglyphs.idl

HRESULT GetCustomGlyphList(
   [in] ULONG BaseIndex,
   [out] PDWORD_PTR pdwImageListHandle
);

If later calls to the GetSccGlyph method returns a value greater than or equal to BaseIndex, then the IDE looks in the custom glyph list that it received from this method to draw the state icon in place of the existing image list.

.NET Framework Security

See Also

Reference

IVsSccGlyphs Interface

Microsoft.VisualStudio.Shell.Interop Namespace