Difference between revisions of "Fs.isReadOnly"
From ComputerCraft Wiki
m (Corrected mapping from "Boolean" to "Boolean (type)") |
(Add note about root and mount points being read-only) |
||
| Line 5: | Line 5: | ||
|api=fs | |api=fs | ||
|returns=[[boolean_(type)|boolean]] <code>false</code> if <var>path</var> can be written to, or <var>true</var> if not | |returns=[[boolean_(type)|boolean]] <code>false</code> if <var>path</var> can be written to, or <var>true</var> if not | ||
| − | |desc=Checks whether a path can be written to (the path need not exist in order to perform this test) | + | |desc=Checks whether a path can be written to (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 | ||
Revision as of 18:57, 21 April 2013
 Function fs.isReadOnly | |
| Checks whether a path can be written to (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 |
