Bruce Pascoe: Add DirectoryStream::rewind() to wiki

2017-08-23T14:15:50Z

Add DirectoryStream::rewind() to wiki

New page

{{DISPLAYTITLE:DirectoryStream::rewind()}}

The '''<tt>DirectoryStream::rewind()</tt>''' [[API:Functions#Core_API|Core API]] method resets a directory stream to the beginning to be read again.

===== Usage =====

''dirstream_obj''.'''rewind'''();

__TOC__

== API Information ==

=== Description ===

<tt>'''DirectoryStream::rewind()'''</tt> refreshes a directory stream and resets its <tt>[[API:DirectoryStream::position|DirectoryStream::position]]</tt> to 0. This allows you to read new or deleted items in a directory without having to construct a new <tt>DirectoryStream</tt> object. Note that this is '''not''' the same as manually setting <tt>[[API:DirectoryStream::position|DirectoryStream::position]]</tt> to 0 as that isn't guaranteed to reflect changes.

=== Parameters ===

This method has no parameters.

=== Return Value ===

This method doesn't return a meaningful value.

== See Also ==

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

[[Category:Sphere 2 API]]

API:DirectoryStream::rewind - Revision history

Bruce Pascoe: Add DirectoryStream::rewind() to wiki