Share via


IDeclarations::GetGlyph Method

Returns the icon of an item in the completion list.

HRESULT GetGlyph ( 
   long index,
   long* glyph
);

Parameters

  • index
    [in] Index position of the item in the completion list.

  • glyph
    [out] Returns an index of an icon to display for the item in the completion list. This value can be -1 to indicate no icon is to be shown. For the list of icons, see Babel Icons.

Return Value

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

Remarks

The icon list is retrieved through a call to the IBabelService::GetImageList Method method. If that method returns E_NOTIMPL, then the default icon list is used. The Babel Package provides a list of 180 default icons that you can use to indicate the type of items displayed in the completion list. For more information, see Babel Icons.

The glyph index comes from the parser; it is one of the parameters passed to the IParseSink::AddScope Method.

The index parameter is typically the value returned from the IDeclarations::GetBestMatch Method.

See Also

Concepts

Babel Icons

Reference

IDeclarations Interface

IDeclarations::GetBestMatch Method