Nintendo MessageStudio ヘルプ

LMS_GetFontIndexByName

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

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

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

構文

libms_s32_t LMS_GetFontIndexByName( LMSProjFile* pFile, const char* pStyleName );

引数

引数名意味
pFileLMSProjFile*参照フォントのインデックス番号を取得したい対象のプロジェクトファイルオブジェクトを指定してください(LMS_InitProject関数で返ってきた値)。
pStyleNameconst char*スタイル名文字列へのポインタを指定してください。 NULL終端のASCII文字列である必要があります。

戻り値

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