Difference between revisions of "ChucK/Dev/IO/FileIO"
From CSWiki
Line 15: | Line 15: | ||
; <code>FileIO.stdin</code><br /><code>FileIO.stdout</code> : Pre-created files for reading from and writing to <tt>stdin</tt> and <tt>stdout</tt>. | ; <code>FileIO.stdin</code><br /><code>FileIO.stdout</code> : Pre-created files for reading from and writing to <tt>stdin</tt> and <tt>stdout</tt>. | ||
; <code>FileIO.MODE_READ_WRITE</code><br /><code>FileIO.MODE_READONLY</code><br /><code>FileIO.MODE_WRITEONLY</code> : These flags can optionally be passed to the <code>open</code> function to specify the mode in which to open the file. | ; <code>FileIO.MODE_READ_WRITE</code><br /><code>FileIO.MODE_READONLY</code><br /><code>FileIO.MODE_WRITEONLY</code> : These flags can optionally be passed to the <code>open</code> function to specify the mode in which to open the file. | ||
+ | |||
+ | ===Examples=== |
Revision as of 12:20, 6 March 2008
The following is subject to change.
FileIO Class
The FileIO class is a subclass of the IO class. Only elements of the FileIO class that extend or override the parent class are listed here.
Methods
-
fun int open(string path[, int flags])
- Opens the specified file, returning true on success and false otherwise. The flags can optionally be used to specify the mode in which to open the file (
FileIO.MODE_READ_WRITE
by default).
Directories
-
fun int isDir()
- Returns true if the opened file is a directory, false otherwise.
-
fun string[] dirList()
- Returns an array containing the names of each file in the opened directory, or an empty array if the opened file is not a directory.
Events
Constants
-
FileIO.stdin
FileIO.stdout
- Pre-created files for reading from and writing to stdin and stdout.
-
FileIO.MODE_READ_WRITE
FileIO.MODE_READONLY
FileIO.MODE_WRITEONLY
- These flags can optionally be passed to the
open
function to specify the mode in which to open the file.