目次 - SDL 3.0 API(機能別) - ファイルシステム - SDL_RenamePath

SDL_RenamePath

ファイル名またはディレクトリ名を変更する

ヘッダ

SDL3/SDL_filesystem.h

構文

bool SDL_RenamePath(const char *oldpath, const char *newpath);

引数

const char *oldpath古いパス名
const char *newpath新しいパス名

戻り値

(bool) 成功のとき真, 失敗のとき偽を戻す. SDL_GetError()を呼んで詳細を知ることができる.

詳細

newpathが既に存在する場合, 置き換えられる.

この関数では, 複雑(多くの時間がかかる)な処理のため, コピーはファイルシステム/ドライブ/ボリューム間では行われない.

そのため, この関数が失敗したならば, SDL_CopyFile()でnewpathと同じディレクトリに一時ファイルをコピーし, その後でSDL_RenamePath()で一時ファイルの名前をnewpathにして, SDL_RemovePath()でoldpathを削除すると同じ事が行える場合がある. しかし, 空でないディレクトリをファイルシステム間で移動するのはさらに複雑である.

スレッドセーフ

この関数はどのスレッドからも安全に呼べる.

バージョン

SDL 3.2.0以降

SDL Wikiへのリンク

SDL_RenamePath - SDL Wiki