CompletionSet.GetCompletionItemColor Method

Article
07/12/2014

Gets the foreground and background colors for a selected item.

Namespace: Microsoft.VisualStudio.Package
Assemblies:   Microsoft.VisualStudio.Package.LanguageService.11.0 (in Microsoft.VisualStudio.Package.LanguageService.11.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.10.0 (in Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
  Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)
  Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)

Syntax

'Declaration
Public Overridable Function GetCompletionItemColor ( _
    iIndex As Integer, _
    <OutAttribute> ByRef dwFGColor As UInteger, _
    <OutAttribute> ByRef dwBGColor As UInteger _
) As Integer

public virtual int GetCompletionItemColor(
    int iIndex,
    out uint dwFGColor,
    out uint dwBGColor
)

public:
virtual int GetCompletionItemColor(
    int iIndex, 
    [OutAttribute] unsigned int% dwFGColor, 
    [OutAttribute] unsigned int% dwBGColor
)

abstract GetCompletionItemColor : 
        iIndex:int * 
        dwFGColor:uint32 byref * 
        dwBGColor:uint32 byref -> int  
override GetCompletionItemColor : 
        iIndex:int * 
        dwFGColor:uint32 byref * 
        dwBGColor:uint32 byref -> int

public function GetCompletionItemColor(
    iIndex : int, 
    dwFGColor : uint, 
    dwBGColor : uint
) : int

Parameters

iIndex
Type: System.Int32

The index of the item for which to get the colors.

dwFGColor
Type: System.UInt32%

[out] Returns the foreground color.

dwBGColor
Type: System.UInt32%

[out] Returns the background color.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK if there are colors set, S_FALSE if the defaults are used. If it fails, it returns an error code.

Implements

IVsCompletionSetEx.GetCompletionItemColor(Int32, UInt32%, UInt32%)

Remarks

This method is the implementation of the GetCompletionItemColor method of the IVsCompletionSetEx interface.

This method is not implemented and returns both dwFGColor and dwBGColor as 0, and returns E_NOTIMPL.

.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