IVsFontAndColorUtilities::GetEncodedIndex Method (UInt32, array<COLORINDEX>^)

Visual Studio 2015
 

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)

C#
C++
F#
VB
Copy 
int GetEncodedIndex(
	unsigned int crSource,
	array<COLORINDEX>^ pIdx
)

Parameters

crSource
Type: System::UInt32

[in] A COLORREF representation of color value.

pIdx
Type: array<Microsoft.VisualStudio.TextManager.Interop::COLORINDEX>^

[out] A valid member of the COLORINDEX enumeration corresponding crSource.

Return Value

Type: System::Int32

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

The COLORREF crSource 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.

Return to top
Show: