# FS_RenameFile

## 構文

    #include <nitro/fs.h>

    BOOL FS_RenameFile(const char *src, const char *dst);

## 引数

src | 変更前のファイルのパス名
dst | 変更後のファイルのパス名

## 返り値

ファイル名が正常に変更されればTRUEを、失敗すればFALSEを返します。
失敗時の詳細なエラーは`FS_GetArchiveResultCode()`で取得することができます。

## 説明

指定したファイルの名前を変更します。ファイルを移動することと同等です。
以下の場合には失敗してFALSEを返します。

- 対象となるアーカイブがファイル名の変更に対応できない場合
- 名前変更前のファイルが存在しない場合
- 名前変更後のファイルがすでに存在する場合

## 注意

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

## 参照

`FS_PERMIT_*
FS_CreateFile FS_DeleteFile FS_GetResultCode`

## 履歴

2007/09/18 初版