IVsCompletionSetEx.GetCompletionItemColor Method

Article
03/11/2013

Returns the foreground and background colors for a selected item.

Namespace: Microsoft.VisualStudio.TextManager.Interop
Assembly: Microsoft.VisualStudio.TextManager.Interop.8.0 (in Microsoft.VisualStudio.TextManager.Interop.8.0.dll)

Syntax

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

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

int GetCompletionItemColor(
    [InAttribute] int iIndex, 
    [OutAttribute] unsigned int% dwFGColor, 
    [OutAttribute] unsigned int% dwBGColor
)

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

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

Parameters

iIndex
Type: System.Int32
[in] CompletionSet item of interest.

dwFGColor
Type: System.UInt32%
[out] Foreground color. For values, see COLORREF.

dwBGColor
Type: System.UInt32%
[out] Background color. For values, see COLORREF.

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

.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