Difference between revisions of "Os.remove"
From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>") |
|||
(8 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
'''Available since:''' Gideros 2011.6<br/> | '''Available since:''' Gideros 2011.6<br/> | ||
+ | '''Class:''' [[os]]<br/> | ||
+ | |||
=== Description === | === Description === | ||
− | Deletes the file or directory with the given name. Directories must be empty to be removed. If this function fails, it returns nil | + | Deletes the file or directory with the given name. Directories must be empty to be removed. If this function fails, it returns nil plus a string describing the error. |
− | < | + | <syntaxhighlight lang="lua"> |
− | + | os.remove(filename) | |
− | </ | + | </syntaxhighlight> |
+ | |||
=== Parameters === | === Parameters === | ||
− | '''filename''': (string) filename to delete <br/> | + | '''filename''': (string) filename to delete<br/> |
+ | |||
+ | {{Os}} |
Latest revision as of 14:31, 13 July 2023
Available since: Gideros 2011.6
Class: os
Description
Deletes the file or directory with the given name. Directories must be empty to be removed. If this function fails, it returns nil plus a string describing the error.
os.remove(filename)
Parameters
filename: (string) filename to delete