Nintendo MessageStudio ヘルプ

LMS_GetFontIndex

この関数は、スタイル情報のインデックス番号から参照フォントのインデックス番号を取得する関数です。

この関数で取得できる、参照フォントのインデックス番号は、フォント情報格納ブロックに対して使用するのものですが、 現在、プロジェクトリソースファイルがフォント情報格納ブロックに対応していないため利用されることはありません。

構文

libms_s32_t LMS_GetFontIndex( LMSProjFile* pFile, libms_s32_t nStyleIndex );

引数

引数名意味
pFileLMSProjFile*参照フォントのインデックス番号を取得したい対象のプロジェクトファイルオブジェクトを指定してください(LMS_InitProject関数で返ってきた値)。
nStyleIndexlibms_u16_tスタイル情報のインデックス番号を指定します(LMS_GetStyleIndexByName関数で取得した値)。

戻り値

成功した場合、参照フォントのインデックス番号が返ります。 指定したスタイルに参照フォントが設定されていなかった場合、eLMSRet_NoReferenceToFontが返ります。 失敗した場合、eLMSRet_NotFoundが返ります。