IVsSccGlyphs::GetCustomGlyphList Method (UInt32, UInt32)

Visual Studio 2015

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

C++

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

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

C++

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.