note Help Needed

This wiki is the result of an ongoing community effort — thank you all for helping!

If you want to provide changes to this page then please click here.

frename

warning

This function was added in omp v1.1.0.2612 and will not work in earlier versions!

warning

This function starts with a lowercase letter.

Description

Rename a file.

Name	Description
const oldname[]	The current name of the file, optionally including a full path.
const newname[]	The new name of the file, optionally including a full path.

Returns

true on success, false on failure.

Examples

if (frename("example.txt", "file.txt"))
{
    // Success
    printf("File \"example.txt\" renamed to \"file.txt\" successfully.");
}
else
{
    // Error
    print("The file \"example.txt\" does not exists, or can't be opened.");
}

Related Functions

fopen: Open a file.
fclose: Close a file.
ftemp: Create a temporary file stream.
fremove: Remove a file.
fwrite: Write to a file.
fputchar: Put a character in a file.
fgetchar: Get a character from a file.
fblockwrite: Write blocks of data into a file.
fblockread: Read blocks of data from a file.
fseek: Jump to a specific character in a file.
flength: Get the file length.
fexist: Check, if a file exists.
fmatch: Check, if patterns with a file name matches.
ftell: Get the current position in the file.
fflush: Flush a file to disk (ensure all writes are complete).
fstat: Return the size and the timestamp of a file.
fcopy: Copy a file.
filecrc: Return the 32-bit CRC value of a file.
diskfree: Returns the free disk space.
fattrib: Set the file attributes.
fcreatedir: Create a directory.