Share via


IVsFontAndColorUtilities.GetEncodedIndex Method

Obtain a valid member of the COLORINDEX enumeration corresponding to a supplied COLORREF.

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

Syntax

'Declaration
Function GetEncodedIndex ( _
    crSource As UInteger, _
    <OutAttribute> pIdx As COLORINDEX() _
) As Integer
int GetEncodedIndex(
    uint crSource,
    COLORINDEX[] pIdx
)
int GetEncodedIndex(
    [InAttribute] unsigned int crSource, 
    [OutAttribute] array<COLORINDEX>^ pIdx
)
abstract GetEncodedIndex : 
        crSource:uint32 * 
        pIdx:COLORINDEX[] byref -> int
function GetEncodedIndex(
    crSource : uint, 
    pIdx : COLORINDEX[]
) : int

Parameters

  • crSource
    Type: UInt32

    [in] A COLORREF representation of color value.

Return Value

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

Remarks

The COLORREFcrSource used as input must a type of CT_COLORINDEX as returned by GetColorType.

If an error occurs, the value of pIdx is undefined.

Managed code can obtain functionality equivalent to GetSysColor with SystemColors and convert between COLORREF and the System.Drawing.Color structure using M:System.Drawing.ColorTranslator.FromWin32 and M:System.Drawing.ColorTranslator.ToWin32.

.NET Framework Security

See Also

Reference

IVsFontAndColorUtilities Interface

Microsoft.VisualStudio.Shell.Interop Namespace

Other Resources

Fonts