LMS_GetColorByName

この関数は、カラーの名前からカラーを取得する関数です。

この関数は、関数の呼び出しを単純化する目的で設けられたヘルパ関数です。内部的にはLMS_GetColorIndexByName関数とLMS_GetColor関数の二つの関数を順番に呼び出しているだけです。

構文

libms_s32_t LMS_GetColorByName( LMSProjFile* pFile, const char* pName, LMSColor* pColor );

引数

引数名	型	意味
pFile	LMSProjFile*	カラーを取得したい対象のプロジェクトファイルオブジェクトを指定してください（LMS_InitProject関数で返ってきた値）。
pName	const char*	カラーの名前を指定します。
pColor	LMSColor*	LMSColor構造体へのポインタを指定します。 この関数によって得られたカラーは、この構造体に格納されます。 NULLを指定することはできません。

戻り値

成功した場合、0が返ります。 CLB1ブロックが存在しなかった場合、eLMSRet_LabelBlockNotFoundが返ります。 CLR1ブロックが存在しなかった場合、eLMSRet_ColorInfoBlockNotFoundが返ります。 指定したインデックス番号のカラーが見つからなかった場合、eLMSRet_NotFoundが返ります。