Nintendo MessageStudio ヘルプ

LMS_SearchProjectBlockByName

指定されたプロジェクトファイルオブジェクトの中に含まれるバイナリブロックを、ブロック名を指定して検索する処理です。バイナリ化されたメッセージリソースファイル(msbtファイル)は、バイナリが中で区画分けされており、柔軟に拡張できるように設計されています。

この関数を普段意識して利用する機会はないかもしれませんが、プラグインによって出力処理を一部変更した場合には、この関数を利用して特定のブロックを検索するときに利用してください。

構文

libms_u16_t LMS_SearchProjectBlockByName( LMSProjFile *pFile, const char* pBlockName );

引数

引数名意味
pFileLMSMsgFile*インデックス番号を検索する対象のプロジェクトファイルオブジェクトを指定してください(LMS_InitProject関数で返ってきた値)。
pBlockNameconst char*ブロックの名称を示す情報へのポインタを指定してください。 指定されたポインタ位置から4バイト分をブロックの名前として認識します。 NULL終端である必要はありません。

戻り値

ブロックのインデックス番号が返ります。ブロックが見つからなかった場合はeLMSRet_NotFoundが返ります。