IVsCompletionSetEx.GetCompletionItemColor(Int32, UInt32, UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.8.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.9.37000

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns the foreground and background colors for a selected item.

public:
 int GetCompletionItemColor(int iIndex, [Runtime::InteropServices::Out] System::UInt32 % dwFGColor, [Runtime::InteropServices::Out] System::UInt32 % dwBGColor);

int GetCompletionItemColor(int iIndex, [Runtime::InteropServices::Out] unsigned int & dwFGColor, [Runtime::InteropServices::Out] unsigned int & dwBGColor);

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

abstract member GetCompletionItemColor : int * uint32 * uint32 -> int

Public Function GetCompletionItemColor (iIndex As Integer, ByRef dwFGColor As UInteger, ByRef dwBGColor As UInteger) As Integer

Parameters

iIndex: Int32

[in] CompletionSet item of interest.

dwFGColor: UInt32

[out] Foreground color. For values, see COLORREF.

dwBGColor: UInt32

[out] Background color. For values, see COLORREF.

Returns

Int32

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

Remarks

COM Signature

From textmgr2.idl:

HRESULT IVsCompletionSetEx::GetCompletionItemColor(  
   [in] long iIndex,  
   [out] COLORREF *dwFGColor,  
   [out] COLORREF *dwBGColor  
);

GetCompletionItemColor returns S_FALSE if the colors are the defaults.

Allows the foreground and background colors of selected items in a completion list to be overridden.

Applies to