os.remove()

Overview

Deletes a file or directory and returns two possible values:

• result — true if the file was successfully removed, otherwise false.
• reason — nil if remove was successful, otherwise a string describing the reason for failure.

Gotchas

You can only remove files in the DocumentsDirectory, ApplicationSupportDirectory and TemporaryDirectory. Files in the ResourceDirectory are read-only.

Syntax

os.remove( file )

Example

local destDir = system.DocumentsDirectory  -- Location where the file is stored
local result, reason = os.remove( system.pathForFile( "apple.txt", destDir ) )
 
if result then
   print( "File removed" )
else
   print( "File does not exist", reason )  --> File does not exist    apple.txt: No such file or directory
end