IVsFontAndColorUtilities::GetEncodedSysColor Method (UInt32, Int32)

Visual Studio 2015
 

Obtain a System Color service index 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 GetEncodedSysColor(
	unsigned int crSource,
	[OutAttribute] int% piSysColor
)

Parameters

crSource
Type: System::UInt32

[in] A COLORREF representation of color value.

piSysColor
Type: System::Int32

[out] The System Color Service index corresponding the 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_SYSCOLOR as returned by GetColorType.

The value of piSysColor is the same as would be used as an argument to GetSysColor to obtain a COLORREF with the value of crSource.

If an error occurs, the value of piSysColor 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: