FS_OpenDirectory[W]

構文


#include <nitro/fs.h>

BOOL FS_OpenDirectory(FSFile *dir, const char *path, u32 mode);
BOOL FS_OpenDirectoryW(FSFile *file, const u16 *path, u32 mode);

引数

dir ハンドルを格納すべきFSFile構造体
path ディレクトリのパス名
mode ディレクトリへのアクセスモード
FS_DIRMODE_*のフラグを組み合わせて指定します。

返り値

ディレクトリハンドルが正しく開ければTRUEを、失敗すればFALSEを返します。
失敗時の詳細なエラーはFS_GetResultCode()で取得することができます。

説明

指定したディレクトリのハンドルを開きます。
パス名をShift_JISで指定する場合はFS_OpenDirectory()を、UTF16-LEで指定する場合はFS_OpenDirectoryW()を使用することができ、得られる結果は同じです。
得られたハンドルを使用してFS_ReadDirectory()を呼び出すことにより、ディレクトリ内のエントリ情報をひとつずつ列挙することができます。
ハンドルを使用した後はFS_CloseDirectory()を呼び出して解放する必要があります。

以下の場合には失敗してFALSEを返します。

注意

参照

FSFile FSDirectoryEntryInfo FSDirectoryEntryInfoW
FS_ReadDirectory FS_CloseDirectory

履歴

2009/07/29 構造体の値コピーが無保証である旨を追記
2008/09/02 Unicode版の関数について追記。
2008/07/16 失敗時のエラーコード取得に関してFS_GetResultCode()を使用するよう記述を訂正。
2007/09/18 初版