IVsSccGlyphs.GetCustomGlyphList Method

Article
04/22/2008

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

'Déclaration
Function GetCustomGlyphList ( _
    BaseIndex As UInteger, _
    <OutAttribute> ByRef pdwImageListHandle As UInteger _
) As Integer
'Utilisation
Dim instance As IVsSccGlyphs
Dim BaseIndex As UInteger
Dim pdwImageListHandle As UInteger
Dim returnValue As Integer

returnValue = instance.GetCustomGlyphList(BaseIndex, _
    pdwImageListHandle)

int GetCustomGlyphList(
    uint BaseIndex,
    out uint pdwImageListHandle
)

int GetCustomGlyphList(
    [InAttribute] unsigned int BaseIndex, 
    [OutAttribute] unsigned int% pdwImageListHandle
)

function GetCustomGlyphList(
    BaseIndex : uint, 
    pdwImageListHandle : uint
) : int

Parameters

BaseIndex
Type: System.UInt32

[in] Value to add when returning glyph index.

pdwImageListHandle
Type: System.UInt32%

[out] Handle to the custom image list.

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

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.

Partager via