MKI_ConvertColorString (Strings) Changed in Version 2026.0

C++ Syntax

bool

MKI_ConvertColorString(

 LPWSTR f_pszText,

 const size_t f_unMaxSize,

 MKI_COLORVALUE f_cColor,

 MKI_COLORMODEL f_cColorMode );

template <size_t f_unSize> bool

MKI_ConvertColorString(

 wchar_t (&f_rDestin)[f_unSize],

 MKI_COLORVALUE f_cColor,

 MKI_COLORMODEL f_cColorMode );

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

Parameters

f_pszText / f_rDestin

[LPWSTR] Pointer to or [wchar_t[]&] Reference to text buffer to receive the color description.

f_cColor

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

f_cColorMode

[MKI_COLORMODEL] This value determines how the content of f_cColor is to be interpreted (see MKI_COLORMODE_*).

Return Value

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