f_unlink

オブジェクトを削除します。

FRESULT f_unlink (
  const XCHAR* FileName  /* オブジェクト名へのポインタ */
);

引数

FileName

削除対象のファイルまたはディレクトリ名の入った'\0'で終わる文字列へのポインタを指定します。

戻り値

FR_OK (0)

正常終了。

FR_NO_FILE

ファイルが見つからない。

FR_NO_PATH

パスが見つからない。

FR_INVALID_NAME

パス名が不正。

FR_INVALID_DRIVE

ドライブ番号が不正。

FR_DENIED

対象オブジェクトがリード・オンリー属性、ディレクトリの場合は空でない場合など。

FR_NOT_READY

メディアがセットされていないなど、物理ドライブが動作不能状態。

FR_WRITE_PROTECTED

メディアが書き込み禁止状態。

FR_DISK_ERR

ディスク・エラーによる失敗。

FR_INT_ERR

不正なFAT構造または内部エラーによる失敗。

FR_NOT_ENABLED

論理ドライブにワーク・エリアが割り当てられていない。

FR_NO_FILESYSTEM

ディスク上に有効なFATボリュームが見つからない。

解説

オブジェクトを削除します。開かれているオブジェクトやカレント・ディレクトリは削除してはなりません。

対応情報

_FS_READONLY == 0で、且つ_FS_MINIMIZE == 0のときに使用可能です。