LMS_GetColorIndexByName

この関数は、カラーの名前からカラー情報へのインデックス番号を取得する関数です。

カラー名の対応情報は、プロジェクトリソースファイル中にある「CLB1ブロック」と呼ばれる区画に格納されます。プロジェクトファイルのブロックについての詳細はLMS_SearchProjectBlockByName関数をご覧ください。

構文

libms_s32_t LMS_GetColorIndexByName( LMSProjFile* pFile, const char* pName );

引数

引数名	型	意味
pFile	LMSProjFile*	プロジェクトファイルのオブジェクトを指定します。
pName	const char*	<% pName_Exp %>

戻り値

成功した場合： カラーのインデックス番号が返ります。 このカラーのインデックス番号はプロジェクトファイルリソースの中でカラー情報を格納する「CLR1ブロック」の中の格納番号になります。 このインデックスを利用してカラー情報を取得することができます。 失敗した場合： CLB1ブロックが存在しなかった場合、eLMSRet_LabelBlockNotFoundが返ります。 指定した名前のカラーが見つからなかった場合、eLMSRet_NotFoundが返ります。