LMS_GetAttrInfoIndexByName

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

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

この関数によって得られる属性情報へのインデックス番号は、プロジェクトリソースファイル中にある「ATI1ブロック」における属性情報の格納番号であり、メッセージリソースファイル中にある「ATR1ブロック」における属性値情報の格納番号ではないことに注意して下さい。 この関数によって得られた属性情報へのインデックス番号は、LMS_GetAttrType関数、LMS_GetAttrOffset関数およびLMS_GetAttrListItemName関数で利用できます。

構文

libms_s32_t LMS_GetAttrInfoIndexByName( LMSProjFile* pFile, const char* pName );

引数

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

戻り値

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