Nintendo MessageStudio ヘルプ

LMS_GetColor

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

構文

libms_s32_t LMS_GetColor( LMSProjFile* pFile, libms_s32_t nColorIndex, LMSColor* pColor );

引数

引数名意味
pFileLMSProjFile*カラーを取得したい対象のプロジェクトファイルオブジェクトを指定してください(LMS_InitProject関数で返ってきた値)。
nColorIndexlibms_s32_tカラーのインデックス番号を指定します(LMS_GetColorIndexByName関数で取得した値)。
pColorLMSColor*LMSColor構造体へのポインタを指定します。 この関数によって得られたカラーは、この構造体に格納されます。 NULLを指定することはできません。

戻り値

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