LMS_GetLabelByTextIndex

この関数は、テキストのインデックス番号から、それに対応するラベルを取得する処理です(逆引き)。おもにデバッグ用途に利用します。

テキストのインデックス番号などに関する概念はLMS_GetTextIndexByLabel関数をご覧ください。

構文

libms_s32_t LMS_GetLabelByTextIndex( LMSMsgFile *pFile, libms_s32_t nTextIndex, char* pLabel );

引数

引数名	型	意味
pFile	LMSMsgFile*	インデックス番号を検索する対象のメッセージファイルオブジェクトを指定してください(LMS_InitMessage関数で返ってきた値)。
nTextIndex	libms_s32_t	ラベルを取得したいテキストのインデックス番号を指定してください。0以上である必要があります。
pLabel	char*	取得できたラベルの値を格納するバッファへのポインタを指定します。LMS_LABEL_MAXLENGTH+1バイト以上のメモリを確保する必要があります。バッファオーバーフローに注意してください。

戻り値

成功した場合非0値が返ります。指定されたnTextIndexが大きすぎるなどの理由で失敗した場合は0が返ります。

注意事項

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