Nintendo MessageStudio ヘルプ

LMS_GetAttrListItemNameByName

この関数は、属性の名前と、その属性がもつリスト項目のインデックス番号から、リスト項目の名前を取得する関数です。

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

構文

const char* LMS_GetAttrListItemNameByName( LMSProjFile* pFile, const char* pAttributeName, libms_s32_t nItemIndex );

引数

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

戻り値

成功した場合、リスト項目名文字列の先頭へのポインタが返ります。リスト項目名文字列はNULL終端しています。 失敗した場合、NULLが返ります。

注意事項

この関数は、属性情報のインデックス番号が示す属性がリスト型(eLMS_Type_List)である属性のみに使用することができます。 pAttributeNameに、リスト型でない属性の名前が指定された場合、この関数は失敗します。