Difference between revisions of "Fs.isReadOnly"
From ComputerCraft Wiki
m (Corrected mapping from "Boolean" to "Boolean (type)") |
(Copy description from API page, fix return formatting, and use type template) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 2: | Line 2: | ||
{{Function | {{Function | ||
|name=fs.isReadOnly | |name=fs.isReadOnly | ||
| − | |args= | + | |args={{Type|string}} path |
|api=fs | |api=fs | ||
| − | |returns= | + | |returns={{Type|boolean}} <code>false</code> if <var>path</var> can be written to, or <code>true</code> if not |
| − | |desc=Checks | + | |desc=Checks if a path is read-only (i.e. cannot be modified). The path need not exist in order to perform this test. Note that the root directory and the mount points of any floppy disks are considered read-only, perhaps because they cannot ''themselves'' be modified, only their ''contents'' can be. |
|examples= | |examples= | ||
{{Example | {{Example | ||
Latest revision as of 19:43, 22 April 2013
 Function fs.isReadOnly | |
| Checks if a path is read-only (i.e. cannot be modified). The path need not exist in order to perform this test. Note that the root directory and the mount points of any floppy disks are considered read-only, perhaps because they cannot themselves be modified, only their contents can be. | |
| Syntax | fs.isReadOnly(string path) |
| Returns | boolean false if path can be written to, or true if not |
| Part of | ComputerCraft |
| API | fs |
Examples
 Example | |
| Checks that the "rom" directory is read-only, as its name implies | |
| Code |
print(fs.isReadOnly("rom"))
|
| Output | true |
