f_rename

ファイルまたはサブ・ディレクトリの名前の変更または移動します。

FRESULT f_rename (
  const TCHAR* old_name, /* [IN] 古いオブジェクト名 */
  const TCHAR* new_name  /* [IN] 新しいオブジェクト名 */
);

引数

old_name
変更対象のファイルまたはサブ・ディレクトリのパス名を示すヌル文字'\0'終端の文字列へのポインタを指定します。
new_name
新しいパス名を示すヌル文字'\0'終端の文字列へのポインタを指定します。既に存在するオブジェクトと同じ名前は使えません。また、ドライブ番号は指定しても無視され、old_nameで決められた論理ドライブ上のオブジェクトとして扱われます。

戻り値

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");

戻る