API:DirectoryStream::rewind

From Spherical
Revision as of 14:15, 23 August 2017 by Bruce Pascoe (talk | contribs) (Add DirectoryStream::rewind() to wiki)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search


The DirectoryStream::rewind() Core API method resets a directory stream to the beginning to be read again.

Usage
dirstream_obj.rewind();

API Information

Description

DirectoryStream::rewind() refreshes a directory stream and resets its DirectoryStream::position to 0. This allows you to read new or deleted items in a directory without having to construct a new DirectoryStream object. Note that this is not the same as manually setting DirectoryStream::position 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