(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_RenamePath

Rename a file or directory.

Header File

Defined in <SDL3/SDL_filesystem.h>

Syntax

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

Function Parameters

const char *	oldpath	the old path.
const char *	newpath	the new path.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

If the file at newpath already exists, it will replaced.

Note that this will not copy files across filesystems/drives/volumes, as that is a much more complicated (and possibly time-consuming) operation.

Which is to say, if this function fails, SDL_CopyFile() to a temporary file in the same directory as newpath, then SDL_RenamePath() from the temporary file to newpath and SDL_RemovePath() on oldpath might work for files. Renaming a non-empty directory across filesystems is dramatically more complex, however.

Version

This function is available since SDL 3.1.3.

---

CategoryAPI, CategoryAPIFunction, CategoryFilesystem

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.