FileDelete: Difference between revisions
Jump to navigation
Jump to search
(New page: __NOTOC__ {{Server function}} Deletes the specified file. ==Syntax== <syntaxhighlight lang="lua"> bool fileDelete ( string filename [, resource res = getThisResource()] ) </syntaxhighlight> ===Required Arguments===...) |
m (mistake) |
||
| (19 intermediate revisions by 8 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | {{Server client function}} | ||
Deletes the specified file. | Deletes the specified file. | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool fileDelete ( string | bool fileDelete ( string filePath ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP|This function is a static function underneath the File class.|[[File]].delete}} | |||
===Required Arguments=== | ===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")''. | |||
===Returns=== | ===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). | 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: | |||
<syntaxhighlight lang="lua"> | |||
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("test.txt") -- delete file | |||
end | |||
</syntaxhighlight> | |||
==See Also== | ==See Also== | ||
{{File_functions}} | {{File_functions}} | ||
Revision as of 14:19, 23 January 2017
Deletes the specified file.
Syntax
bool fileDelete ( string filePath )
OOP Syntax Help! I don't understand this!
- Note: This function is a static function underneath the File class.
- Method: File.delete(...)
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").
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("test.txt") -- delete file
end
See Also
- fileClose
- fileCopy
- fileCreate
- fileDelete
- fileExists
- fileFlush
- fileGetPath
- fileGetPos
- fileGetSize
- fileIsEOF
- fileOpen
- fileRead
- fileRename
- fileSetPos
- fileWrite