<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>Class Poco::DirectoryIterator</title> <meta http-equiv="content-type" content="text/html; charset=utf-8"/> <meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/> <meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/> <meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/> <meta name="language" content="en"/> <meta name="date" content="2009-11-24"/> <meta name="generator" content="PocoDoc"/> <link rel="stylesheet" href="css/styles.css" type="text/css"/> </head> <body bgcolor="#ffffff" leftmargin="0" topmargin="0"> <div class="header"> <h1 class="namespace"><a href="Poco.html" class="namespace">Poco</a></h1> <h1 class="symbol">class DirectoryIterator</h1> </div> <div class="body"> <p> <b>Library:</b> Foundation<br /> <b>Package:</b> Filesystem<br /> <b>Header:</b> Poco/DirectoryIterator.h</p> <h2>Description</h2> <div class="description"> <p>The <a href="Poco.DirectoryIterator.html" title="class Poco::DirectoryIterator">DirectoryIterator</a> class is used to enumerate all files in a directory. </p> <p><a href="Poco.DirectoryIterator.html" title="class Poco::DirectoryIterator">DirectoryIterator</a> has some limitations: </p> <ul> <li>only forward iteration (++) is supported </li> <li>an iterator copied from another one will always point to the same file as the original iterator, even is the original iterator has been advanced (all copies of an iterator share their state with the original iterator) </li> <li>because of this you should only use the prefix increment operator </li> </ul> </div> <h2>Member Summary</h2> <p><b>Member Functions: </b><a href="Poco.DirectoryIterator.html#4798" title="Poco::DirectoryIterator::name()">name</a>, <a href="Poco.DirectoryIterator.html#4817" title="Poco::DirectoryIterator::operator !=()">operator !=</a>, <a href="Poco.DirectoryIterator.html#4811" title="Poco::DirectoryIterator::operator *()">operator *</a>, <a href="Poco.DirectoryIterator.html#4808" title="Poco::DirectoryIterator::operator ++()">operator ++</a>, <a href="Poco.DirectoryIterator.html#4800" title="Poco::DirectoryIterator::operator =()">operator =</a>, <a href="Poco.DirectoryIterator.html#4815" title="Poco::DirectoryIterator::operator ==()">operator ==</a>, <a href="Poco.DirectoryIterator.html#4813" title="Poco::DirectoryIterator::operator->()">operator-></a>, <a href="Poco.DirectoryIterator.html#4799" title="Poco::DirectoryIterator::path()">path</a></p> <h2>Constructors</h2> <h3><a name="4788">DirectoryIterator</a></h3> <p class="decl"><a href="Poco.DirectoryIterator.html" title="class Poco::DirectoryIterator">DirectoryIterator</a>();</p> <div class="description"> <p>Creates the end iterator. </p> </div> <h3><a name="4789">DirectoryIterator</a></h3> <p class="decl"><a href="Poco.DirectoryIterator.html" title="class Poco::DirectoryIterator">DirectoryIterator</a>(<br /> const std::string & path<br />);</p> <div class="description"> <p>Creates a directory iterator for the given path. </p> </div> <h3><a name="4791">DirectoryIterator</a></h3> <p class="decl"><a href="Poco.DirectoryIterator.html" title="class Poco::DirectoryIterator">DirectoryIterator</a>(<br /> const <a href="Poco.DirectoryIterator.html" title="class Poco::DirectoryIterator">DirectoryIterator</a> & iterator<br />);</p> <div class="description"> <p>Creates a directory iterator for the given path. </p> </div> <h3><a name="4793">DirectoryIterator</a></h3> <p class="decl"><a href="Poco.DirectoryIterator.html" title="class Poco::DirectoryIterator">DirectoryIterator</a>(<br /> const <a href="Poco.File.html" title="class Poco::File">File</a> & file<br />);</p> <div class="description"> <p>Creates a directory iterator for the given file. </p> </div> <h3><a name="4795">DirectoryIterator</a></h3> <p class="decl"><a href="Poco.DirectoryIterator.html" title="class Poco::DirectoryIterator">DirectoryIterator</a>(<br /> const <a href="Poco.Path.html" title="class Poco::Path">Path</a> & path<br />);</p> <div class="description"> <p>Creates a directory iterator for the given path. </p> </div> <h2>Destructor</h2> <h3><a name="4797">~DirectoryIterator</a></h3> <p class="decl">~<a href="Poco.DirectoryIterator.html" title="class Poco::DirectoryIterator">DirectoryIterator</a>();</p> <div class="description"> <p>Destroys the <a href="Poco.DirectoryIterator.html" title="class Poco::DirectoryIterator">DirectoryIterator</a>. </p> </div> <h2>Member Functions</h2> <h3><a name="4798">name</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">const std::string & name() const;</p> <div class="description"> <p>Returns the current filename. </p> </div> <h3><a name="4817">operator !=</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">bool operator != (<br /> const <a href="Poco.DirectoryIterator.html" title="class Poco::DirectoryIterator">DirectoryIterator</a> & iterator<br />) const;</p> <div class="description"> <p></p> </div> <h3><a name="4811">operator *</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">const <a href="Poco.File.html" title="class Poco::File">File</a> & operator * () const;</p> <div class="description"> <p></p> </div> <h3><a name="4812">operator *</a></h3> <p class="decl"><a href="Poco.File.html" title="class Poco::File">File</a> & operator * ();</p> <div class="description"> <p></p> </div> <h3><a name="4808">operator ++</a></h3> <p class="decl"><a href="Poco.DirectoryIterator.html" title="class Poco::DirectoryIterator">DirectoryIterator</a> & operator ++ ();</p> <div class="description"> <p></p> </div> <h3><a name="4809">operator ++</a></h3> <p class="decl"><a href="Poco.DirectoryIterator.html" title="class Poco::DirectoryIterator">DirectoryIterator</a> operator ++ (<br /> int<br />);</p> <div class="description"> <p><b>Deprecated.</b> <i>This function is deprecated and should no longer be used.</i></p> </div> <div class="description"> <p>Please use the prefix increment operator instead. </p> </div> <h3><a name="4800">operator =</a></h3> <p class="decl"><a href="Poco.DirectoryIterator.html" title="class Poco::DirectoryIterator">DirectoryIterator</a> & operator = (<br /> const <a href="Poco.DirectoryIterator.html" title="class Poco::DirectoryIterator">DirectoryIterator</a> & it<br />);</p> <div class="description"> <p></p> </div> <h3><a name="4802">operator =</a></h3> <p class="decl"><a href="Poco.DirectoryIterator.html" title="class Poco::DirectoryIterator">DirectoryIterator</a> & operator = (<br /> const <a href="Poco.File.html" title="class Poco::File">File</a> & file<br />);</p> <div class="description"> <p></p> </div> <h3><a name="4804">operator =</a></h3> <p class="decl"><a href="Poco.DirectoryIterator.html" title="class Poco::DirectoryIterator">DirectoryIterator</a> & operator = (<br /> const <a href="Poco.Path.html" title="class Poco::Path">Path</a> & path<br />);</p> <div class="description"> <p></p> </div> <h3><a name="4806">operator =</a></h3> <p class="decl"><a href="Poco.DirectoryIterator.html" title="class Poco::DirectoryIterator">DirectoryIterator</a> & operator = (<br /> const std::string & path<br />);</p> <div class="description"> <p></p> </div> <h3><a name="4815">operator ==</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">bool operator == (<br /> const <a href="Poco.DirectoryIterator.html" title="class Poco::DirectoryIterator">DirectoryIterator</a> & iterator<br />) const;</p> <div class="description"> <p></p> </div> <h3><a name="4813">operator-></a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">const <a href="Poco.File.html" title="class Poco::File">File</a> * operator-> () const;</p> <div class="description"> <p></p> </div> <h3><a name="4814">operator-></a></h3> <p class="decl"><a href="Poco.File.html" title="class Poco::File">File</a> * operator-> ();</p> <div class="description"> <p></p> </div> <h3><a name="4799">path</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">const <a href="Poco.Path.html" title="class Poco::Path">Path</a> & path() const;</p> <div class="description"> <p>Returns the current path. </p> </div> <p class="footer">POCO C++ Libraries 1.3.6-all<br /> Copyright © 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p> </div> </body> </html>
