FS_RegisterArchiveName

構文

#include <nitro/fs.h>

BOOL FS_RegisterArchiveName(FSArchive *p_arc, const char *name, u32 name_len);

引数

返り値

アーカイブが指定の名前で正しくファイルシステムに登録された場合は TRUE を、そうでないなら FALSE を返します。

説明

指定された名前でアーカイブをファイルシステムに登録します。
nameは英数字のみ使用可能で、大小文字は区別されず小文字へ統一されます。
nameがname_lenの長さより短い位置に終端文字 '\0' を含む場合、その長さが採用されます。

空文字列 "" を指定したり name_len が FS_ARCHIVE_NAME_LEN_MAX より長い場合は失敗します。
また、指定した文字列と同じ名前がすでにファイルシステムに登録されている場合も失敗します。
ファイルシステムは FS_Init() による初期化時に"rom"という名前のアーカイブを登録するので、
この名前 "rom" は使用できません。

登録されたアーカイブは、FS_LoadArchive() でファイルシステムにロードすることができます。
名前を登録してから実際にロードするまでの期間に、制限はありません。
また、ロードとアンロードを繰り返して同じ名前を何度でも使用することができます。

参照

FSArchive FS_ARCHIVE_NAME_LEN_MAX
FS_ReleaseArchiveName FS_LoadArchive FS_UnloadArchive