Nintendo MessageStudio ヘルプ

LMS_GetText

この関数は、メッセージリソースファイルの中にある「TXT2ブロック」と呼ばれる区画の中に格納されている実際のテキスト情報を取得します。 フォーマットに関する詳しい説明は、メッセージバイナリフォーマットの項をご覧ください。

構文

const void* LMS_GetText( LMSMsgFile *pFile, libms_s32_t nTextIndex );

引数

引数名意味
pFileLMSMsgFile*インデックス番号を検索する対象のメッセージファイルオブジェクトを指定してください (LMS_InitMessage関数で返ってきた値)。
nTextIndexlibms_s32_t取得したいテキストのインデックス番号を指定します。 テキストのインデックス番号とは、「TXT2ブロック」の中に格納されている順番のことです。 この番号は、プログラムのヘッダファイルを元に指定するか、フローチャートの情報を元に指定するか、 LMS_GetTextIndexByLabel関数を利用して取得することができます。

この関数と、LMS_GetTextIndexByLabel関数を合体させた関数も用意されています。 詳しくはLMS_GetTextByLabelをご覧ください。

戻り値

実際のテキスト情報が、指定された文字コード形式で返ります。 この値はconst void*型になっていますのでキャストして使用してください。 このテキスト情報の中に、ユーザーはタグを埋め込むことが出来ます。 このタグ情報は決まったフォーマットによって出力されますので、この情報を適切にハンドリングする必要があります。 詳しくは、タグのバイナリフォーマットの項もご覧ください。