f_rename

オブジェクトの名前の変更または移動。

FRESULT f_rename (
  const TCHAR* OldName, /* 古いオブジェクト名 */
  const TCHAR* NewName  /* 新しいオブジェクト名 */
);

引数

OldName
変更対象のオブジェクト(ファイルまたはディレクトリ)へのパス名の入った'\0'で終わる文字列へのポインタを指定します。
NewName
新しいオブジェクトのフルパス名の入った'\0'で終わる文字列へのポインタを指定します。既に存在する名前は使えません。また、ドライブ番号は指定できず、OldNameで指定された論理ドライブ上のオブジェクトとして扱われます。

戻り値

FR_OK, FR_DISK_ERR, FR_INT_ERR, FR_NOT_READY, FR_NO_FILE, FR_NO_PATH, FR_INVALID_NAME, FR_EXIST, FR_WRITE_PROTECTED, FR_INVALID_DRIVE, FR_NOT_ENABLED, FR_NO_FILESYSTEM, FR_TIMEOUT, FR_LOCKED

解説

オブジェクトの名前を変更します。また、別のディレクトリへの移動も可能です。開かれているオブジェクトに対して使用してはなりません。

対応情報

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

使用例

    /* ファイルまたはサブディレクトリの名前を変更する */
    f_rename("oldname.txt", "newname.txt");

    /* ファイルまたはサブディレクトリの名前の変更と別のディレクトリへの移動 */
    f_rename("oldname.txt", "dir1/newname.txt");

戻る