API:DirectoryStream - Revision history

Bruce Pascoe: Add DirectoryStream::dispose()

2017-08-14T03:26:34Z

Add DirectoryStream::dispose()

Bruce Pascoe: More organization - split function and class info

2017-08-12T14:34:02Z

More organization - split function and class info

Bruce Pascoe: Add See Also section

2017-08-12T04:31:07Z

Add See Also section

Bruce Pascoe: Create DirectoryStream constructor page

2017-08-12T04:27:53Z

Create DirectoryStream constructor page

New page

{{DISPLAYTITLE:new DirectoryStream()}}

The '''<tt>new DirectoryStream()</tt>''' constructor initializes an object that allows you to enumerate the contents of a directory.

===== Usage =====

''dirstream_obj'' = '''new DirectoryStream'''(''dir_name'');

__TOC__

== API Information ==

=== Description ===

<tt>'''new DirectoryStream()'''</tt> constructs a Directory Stream object, which allows you to enumerate the contents of a directory. Directory streams only provide filenames; you must use a <tt>[[API:FileStream|FileStream]]</tt> to access the contents of a file.

<table>
<tr>
<td>''Note:''</td>
<td><tt>DirectoryStream</tt> objects are compatible with the JavaScript ''iterator protocol'', so you can use them in a <tt>[[API:from|from()]]</tt> query.</td>
</tr>
</table>

=== Parameters ===

<table>
<tr>
<td align=right width=100>'''''dir_name'''''</td>
<td>Path to the directory to be enumerated. Relative to the game manifest unless a SphereFS prefix is included.</td>
</tr>
</table>

=== Properties ===

<tt>
* [[API:DirectoryStream::fileCount|DirectoryStream::fileCount]]
* [[API:DirectoryStream::fileName|DirectoryStream::fileName]]
* [[API:DirectoryStream::position|DirectoryStream::position]]
</tt>

=== Methods ===

<tt>
* [[API:DirectoryStream::next|DirectoryStream::next()]]
* [[API:DirectoryStream::rewind|DirectoryStream::rewind()]]
</tt>

[[Category:Sphere 2 API]]

@@ Line 48: / Line 48: @@
 <tt>
 * [[API:DirectoryStream::next|DirectoryStream::next()]]
 * [[API:DirectoryStream::rewind|DirectoryStream::rewind()]]

@@ Line 18: / Line 18: @@
 <tr>
 <td>''Note:''</td>
-<td><tt>DirectoryStream</tt> objects are compatible with the JavaScript ''iterator protocol'', so you can use them in a <tt>[[API:from|from()]]</tt> query.</td>
+<td>The <tt>DirectoryStream</tt> class implements the JavaScript ''iterator protocol'', which means you can use them in <tt>[[API:from|from()]]</tt> queries and <tt>for-of</tt> loops.</td>
 </tr>
 </table>
@@ Line 30: / Line 30: @@
 </tr>
 </table>
 === Properties ===