ost::DirTree - A generic class to walk a hierarchical directory structure.

       Generated automatically by Doxygen for GNU CommonC++ from the source code.

GNU CommonC++                                    Sun Dec 27 2020                                 ost::DirTree(3)

ost::DirTree::DirTree(constchar*prefix,unsignedmaxdepth)
       Construct a directory tree walk starting at the specified prefix. A maximum subdirectory depth is also
       specified.

       Parametersprefix to start walk.
           maxdepth subdirectory depth to examine.

   ost::DirTree::DirTree(unsignedmaxdepth)
       Construct an un-opened directory tree of a known maximum depth.

       Parametersmaxdepth subdirectory subdirectory depth.

   virtualost::DirTree::~DirTree()[virtual]

       A generic class to walk a hierarchical directory structure.

       Author
           David Sugar dyfet@ostel.com

       Directory tree walking.

voidost::DirTree::close(void)
       Close the directory path.

   virtualboolost::DirTree::filter(constchar*file,structstat*ino)[protected],[virtual]
       Virtual method to filter results. Virtual override methods should call baseclass method to assure . and
       .. names are stripped out.

       Returns
           true if current filename is accepted.

       Parametersfile path to examine
           ino info of type, date, etc.

   char*ost::DirTree::getPath(void)
       Extract the next full pathname from the directory walk. When returning directories, a '/' is appended.
       The returned string is a buffer of MAX_PATH size.

       Returns
           path of next subdirectory entry or NULL.

   voidost::DirTree::open(constchar*prefix)
       Open a directory tree path.

       Parametersprefix directory path to open.

   unsignedost::DirTree::perform(constchar*prefix)
       This is used to step through the filter virtual for an entire subtree, and is used for cases where a
       derived DirTree class performs it's primary operations through filter rather than externally by calling
       getPath().

       Returns
           number of files and directories examined.

       Parametersprefix directory path to examine.

       ost::DirTree - A generic class to walk a hierarchical directory structure.

       #include <file.h>

   PublicMemberFunctionsDirTree (const char *prefix, unsigned maxdepth)
           Construct a directory tree walk starting at the specified prefix.
       DirTree (unsigned maxdepth)
           Construct an un-opened directory tree of a known maximum depth.
       virtual ~DirTree ()
       void open (const char *prefix)
           Open a directory tree path.
       void close (void)
           Close the directory path.
       char * getPath (void)
           Extract the next full pathname from the directory walk.
       unsigned perform (const char *prefix)
           This is used to step through the filter virtual for an entire subtree, and is used for cases where a
           derived DirTree class performs it's primary operations through filter rather than externally by
           calling getPath().

   ProtectedMemberFunctions
       virtual bool filter (const char *file, struct stat *ino)
           Virtual method to filter results.