LMS_GetStyleIndexByName

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

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

この関数によって得られたスタイル情報へのインデックス番号は、LMS_GetRegionWidth関数、LMS_GetLineNum関数およびLMS_GetFontIndex関数で利用できます。

構文

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

引数

引数名	型	意味
pFile	LMSProjFile*	プロジェクトファイルのオブジェクトを指定します。
pStyleName	const char*	インデックス番号を取得したいスタイル名文字列へのポインタを指定してください。 NULL終端のASCII文字列である必要があります。

戻り値

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