FS_DeleteDirectory

構文

#include <nitro/fs.h>

BOOL FS_DeleteDirectory(const char *path);

引数

返り値

ディレクトリが正常に削除されればTRUEを、失敗すればFALSEを返します。
失敗時の詳細なエラーはFS_GetArchiveResultCode()で取得することができます。

説明

指定したディレクトリを削除します。
以下の場合には失敗してFALSEを返します。

• 対象となるアーカイブがディレクトリの削除に対応できない場合
• 指定したディレクトリが存在しない場合
• 指定したディレクトリが空でない場合

注意

• この関数を割り込みハンドラ(IRQモード)から呼び出すことはできません。
  また、割り込みを禁止したままの状態にあると処理が完了しない場合がある点に注意して下さい。

参照

FS_PERMIT_*
FS_CreateDirectory FS_RenameDirectory FS_GetResultCode

履歴

2009/02/05 エラー要因の説明を追記
2007/09/18 初版