MKI_ConvertColorString (Strings) Changed in Version 2019.0

C++ Syntax

bool

MKI_ConvertColorString(

 MKI_COLORVALUE f_cColor,

 MKI_COLORMODEL f_cColorMode,

 LPWSTR f_pszText );

Returns the textual description of the given color, consisting of its color components and, if available, its name.

Parameters

Color

[MKI_COLORVALUE] Color whose description shall be calculated in the notation defined by ColorMode.

ColorMode

[MKI_COLORMODEL] The value ColorMode determines how the content of Color is to be interpreted (see MKI_COLORMODE_*).

Text

[LPWSTR] Text buffer to receive the color description. Allow at least MKI_LENGTH_NAME_LONG characters!

Return Value

Returns true if successful. If false is returned, Text is unchanged.