Nintendo MessageStudio ヘルプ

LMS_GetTextStyleByLabel

この関数によって、テキストのラベルからそれに対応するテキストがどのスタイルと 関連付けられているかを取得することが出来ます。 テキストのラベルとはメッセージファイルに 設定することができるテキストの識別子のことです。

テキストラベルの対応情報は、メッセージリソースファイル中にある 「LBL1ブロック」と呼ばれる区画に格納されます。 また、スタイルとテキストとの対応情報は「TSY1ブロック」と呼ばれる 区画に格納されることになります。 フォーマットに関する詳しい説明は、メッセージバイナリフォーマットの項をご覧ください。

構文

libms_s32_t LMS_GetTextStyleByLabel( LMSMsgFile *pFile, const char* pLabel );

引数

引数名意味
pFileLMSMsgFile*インデックス番号を検索する対象のメッセージファイルオブジェクトを指定してください(LMS_InitMessage関数で返ってきた値)。
pLabelconst char*検索したいラベル文字列へのポインタを指定してください。NULL終端のASCII文字列である必要があります。

戻り値

設定されていたスタイルのインデックス番号が返ります。 スタイルのインデックス番号とは、 プロジェクトに登録されている順番に0から増えていく番号です。

注意事項

この関数を利用する場合、データの出力設定で「テキストラベルの対応情報ブロック(LBL1)を埋め込む」に チェックを入れておく必要があります(規定値は出力する設定になっています)。 また、「テキストごとのスタイル情報ブロックを出力する(TSY1)」にも チェックを入れておく必要があります(規定値ではこれは出力しない設定です)。

この関数はMessage Studio Ver1.2.x以降で利用可能です。

参考

ラベル情報はハッシュ値としてファイルに書き込まれるため、テキストの数が増えたからと言って線形に処理負荷が増加することはありません。 ただし、ハッシュ値を計算する過程で数回の乗算を利用するため、なるべくこの関数を呼び出さないほうが処理速度的には有利です。