IVsFontAndColorUtilities::EncodeIndexedColor Method (COLORINDEX, UInt32)

Visual Studio 2015
 

Translates a member of the COLORINDEX enumeration into its RGB (COLORREF) color value equivalent.

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 EncodeIndexedColor(
	COLORINDEX idx,
	[OutAttribute] unsigned int% pcrResult
)

Parameters

idx
Type: Microsoft.VisualStudio.TextManager.Interop::COLORINDEX

[in] A valid member of the COLORINDEX enumeration

pcrResult
Type: System::UInt32

[out] A COLORREF equivalent to the COLORINDEX supplied.

Return Value

Type: System::Int32

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

The value returned in pcrResult is a COLORREF representation of the current color value of the component indicated by the COLORINDEX enumeration used as the argument idx.

The COLORREF value will have a type of CT_COLORINDEX as returned by GetColorType.

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: