IVsFontAndColorUtilities.GetEncodedVSColor(UInt32, Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.9.37000

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 valid member of the __VSSYSCOLOREX enumeration corresponding to a supplied COLORREF.

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

int GetEncodedVSColor(unsigned int crSource, [Runtime::InteropServices::Out] int & pVSColor);

public int GetEncodedVSColor (uint crSource, out int pVSColor);

abstract member GetEncodedVSColor : uint32 * int -> int

Public Function GetEncodedVSColor (crSource As UInteger, ByRef pVSColor As Integer) As Integer

Parameters

crSource: UInt32

[in] A COLORREF representation of color value.

pVSColor: Int32

[out] A valid member of the __VSSYSCOLOREX enumeration corresponding 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_VSCOLOR as returned by GetColorType.

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