C++ Syntax

bool

MKI_ProfileReadColor(

const LPCWSTR f_pszValueName,

MKI_CONST_COLORVALUE_REF f_rColor,

MKI_CONST_COLORMODEL_REF f_rColorMode );

Reads a color value from a previously opened key in the configuration file or a collection item.

Parameters

ValueName

[const LPCWSTR] Name of the value inside the plug-in's key, up to 63 characters. This value name must be unique throughout all values stored by the plug-in. Use a point as separator for nested value names and brackets for arrays (e.g. "UserData[5].Name").

Color

[MKI_CONST_COLORVALUE_REF] Color in the notation defined by ColorMode.

ColorMode

[MKI_CONST_COLORMODEL_REF] Determines how the content of Color is to be interpreted (see MKI_COLORMODE_*).

Return Value

Returns true if successful, false if not. The content of Color and ColorMode will only be altered if true is returned.