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.

fremove

warning

This function starts with a lowercase letter.

Description

Delete a file.

Name	Description
const filename[]	The path of the file to delete.

Returns

true - The function executed successfully.

false - The function failed to execute. The file doesn't exist, or you don't have permission to delete it.

Examples

Delete a file:

if (fremove("example.txt"))
{
    print("The file \"example.txt\" removed.");
}
else
{
    print("The file \"example.txt\" does not exists.");
}

Delete a directory:

if (fremove("logs"))
{
    print("The directory \"logs\" removed.");
}
else
{
    print("The directory \"logs\" does not exists, or it is not empty.");
}

Notes

tip

Files that are currently open (fopen) must be closed first (fclose) to be deleted.

warning

The file path must be valid.

Related Functions

fopen: Open a file.
fclose: Close a file.
ftemp: Create a temporary file stream.
fwrite: Write to a file.
fread: Read 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.
frename: Rename 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.