IVsFontAndColorUtilities.GetEncodedSysColor(UInt32, Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.8.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Obtain a System Color service index corresponding to a supplied COLORREF.

public:
 int GetEncodedSysColor(System::UInt32 crSource, [Runtime::InteropServices::Out] int % piSysColor);

int GetEncodedSysColor(unsigned int crSource, [Runtime::InteropServices::Out] int & piSysColor);

public int GetEncodedSysColor (uint crSource, out int piSysColor);

abstract member GetEncodedSysColor : uint32 * int -> int

Public Function GetEncodedSysColor (crSource As UInteger, ByRef piSysColor As Integer) As Integer

Parameters

crSource: UInt32

[in] A COLORREF representation of color value.

piSysColor: Int32

[out] The System Color Service index corresponding the crSource.

Returns

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

Applies to