devela::_dep::sdl3::sys::everything

Function SDL_RenamePath

pub unsafe extern "C" fn SDL_RenamePath(
    oldpath: *const i8,
    newpath: *const i8,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

Rename a file or directory.

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.

§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.