Difference between revisions of "API:DirectoryStream"
From Spherical
Bruce Pascoe (talk | contribs) (Create DirectoryStream constructor page) |
Bruce Pascoe (talk | contribs) (Add See Also section) |
||
| Line 44: | Line 44: | ||
* [[API:DirectoryStream::next|DirectoryStream::next()]] | * [[API:DirectoryStream::next|DirectoryStream::next()]] | ||
* [[API:DirectoryStream::rewind|DirectoryStream::rewind()]] | * [[API:DirectoryStream::rewind|DirectoryStream::rewind()]] | ||
| + | </tt> | ||
| + | |||
| + | == See Also == | ||
| + | |||
| + | <tt> | ||
| + | * [[API:from|from()]] | ||
| + | * [[API:FileStream|new FileStream()]] | ||
</tt> | </tt> | ||
[[Category:Sphere 2 API]] | [[Category:Sphere 2 API]] | ||
Revision as of 04:31, 12 August 2017
The new DirectoryStream() constructor initializes an object that allows you to enumerate the contents of a directory.
Usage
dirstream_obj = new DirectoryStream(dir_name);
Contents
API Information
Description
new DirectoryStream() constructs a Directory Stream object, which allows you to enumerate the contents of a directory. Directory streams only provide filenames; you must use a FileStream to access the contents of a file.
| Note: | DirectoryStream objects are compatible with the JavaScript iterator protocol, so you can use them in a from() query. |
Parameters
| dir_name | Path to the directory to be enumerated. Relative to the game manifest unless a SphereFS prefix is included. |
Properties
Methods
See Also
