SDL_RenamePath - Man Page
Rename a file or directory.
Header File
Defined in SDL3/SDL_filesystem.h
Synopsis
#include "SDL3/SDL.h" bool SDL_RenamePath(const char *oldpath, const char *newpath);
Description
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.
Function Parameters
- oldpath
the old path.
- newpath
the new path.
Return Value
Returns true on success or false on failure; call
SDL_GetError () for more information.
Availability
This function is available since SDL 3.2.0.
Info
SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS