FileDelete

Deletes the specified file.

Syntax

Click to collapse [-]

Server

bool fileDelete ( string filePath )

Required Arguments

• filePath: The filepath of the file to delete in the following format: ":resourceName/path". 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file.

For example, if you want to delete a file name "myFile.txt" in the resource 'fileres', it can be deleted from another resource this way: fileDelete(":fileres/myFile.txt").

If the file is in the current resource, only the file path is necessary, e.g. fileDelete("myFile.txt").

Click to collapse [-]

Client

bool fileDelete ( string filePath [, string accessType = "public" ] )

Required Arguments

• filePath: The filepath of the file to delete in the following format: ":resourceName/path". 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file.

For example, if you want to delete a file name "myFile.txt" in the resource 'fileres', it can be deleted from another resource this way: fileDelete(":fileres/myFile.txt").

If the file is in the current resource, only the file path is necessary, e.g. fileDelete("myFile.txt").

Optional Arguments

• accessType : This setting determines whether to delete the public or private version of the file at filePath
  • "public" will delete the file that is shared by all servers.
  • "private" will delete the file that only the current server is allowed to access. Note: It is only possible to delete a private file if it was previously saved as "private" by the current server.

Returns

Returns true if successful, false otherwise (for example if there exists no file with the given name, or it does exist but is in use).

Example

This example will show us how to create a file "text.txt" spell it "This is a test file!", Close the file and delete it:

local newFile = fileCreate("test.txt")                -- attempt to create a new file
if (newFile) then                                     -- check if the creation succeeded
    fileWrite(newFile, "This is a test file!")        -- write a text line
    fileClose(newFile)                                -- close the file once you're done with it
    fileDelete(newFile)                               -- delete file
end

See Also

• fileClose
• fileCopy
• fileCreate
• fileDelete
• fileExists
• fileFlush
ADDED/UPDATED IN VERSION 1.6.0 r21938:
fileGetContents
• fileGetPath
• fileGetPos
• fileGetSize
• fileIsEOF
• fileOpen
• fileRead
• fileRename
• fileSetPos
• fileWrite