IVsFontAndColorUtilities.EncodeIndexedColor Method
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)
Syntax
'Declaration
Function EncodeIndexedColor ( _
idx As COLORINDEX, _
<OutAttribute> ByRef pcrResult As UInteger _
) As Integer
int EncodeIndexedColor(
COLORINDEX idx,
out uint pcrResult
)
int EncodeIndexedColor(
[InAttribute] COLORINDEX idx,
[OutAttribute] unsigned int% pcrResult
)
abstract EncodeIndexedColor :
idx:COLORINDEX *
pcrResult:uint32 byref -> int
function EncodeIndexedColor(
idx : COLORINDEX,
pcrResult : uint
) : int
Parameters
idx
Type: Microsoft.VisualStudio.TextManager.Interop.COLORINDEX[in] A valid member of the COLORINDEX enumeration
pcrResult
Type: UInt32%[out] A COLORREF equivalent to the COLORINDEX supplied.
Return Value
Type: Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.
Remarks
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.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.
See Also
Reference
IVsFontAndColorUtilities Interface
Microsoft.VisualStudio.Shell.Interop Namespace