Condividi tramite


IVsFontAndColorUtilities.EncodeSysColor(Int32, UInt32) Method

Definition

Returns a RGB (COLORREF) color value corresponding to a specified system color component.

public:
 int EncodeSysColor(int iSysColor, [Runtime::InteropServices::Out] System::UInt32 % pcrResult);
int EncodeSysColor(int iSysColor, [Runtime::InteropServices::Out] unsigned int & pcrResult);
public int EncodeSysColor (int iSysColor, out uint pcrResult);
abstract member EncodeSysColor : int * uint32 -> int
Public Function EncodeSysColor (iSysColor As Integer, ByRef pcrResult As UInteger) As Integer

Parameters

iSysColor
Int32

[in] Valid system color component value.

pcrResult
UInt32

[out] An RGB (COLORREF) representation of the specified system component color.

Returns

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

Remarks

Valid system component must be valid inputs to GetSysColor. For a list of valid values, see System Colors.

The value of pcrResult returns the current color value of the component.

The COLORREF will have a type of CT_SYSCOLOR 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.

Applies to