CascadeDirScanner.h

Go to the documentation of this file.

//
// CascadeDirScanner.h - header file for class CascadeDirScanner
//
// Copyright (c) 2003, Roku, LLC.  All rights reserved.
//

#ifndef _ROKU_INCLUDE_CASCADE_UTIL_CASCADEDIRSCANNER_H
#define _ROKU_INCLUDE_CASCADE_UTIL_CASCADEDIRSCANNER_H

#include <cascade/CascadeObject.h>

// class CascadeDirScanner
class CascadeDirScanner : public CascadeObject
{
public:
        CascadeDirScanner(const char * pDirName);
        // construct CascadeDirScanner passing in a directory name as pDirName
        // CascadeDirScanner will scan the directory and remember all of the
        // directory entries (files) encountered.
        
        CascadeDirScanner(const char * pDirName, const char * pMatchPrefix);
        // construct CascadeDirScanner with a pMatchPrefix and it will only
        // remember files whose prefix matches *pMatchPrefix
        
        virtual ~CascadeDirScanner();
        // Memory allocated by the dir scanner doesn't get freed until
        // the dir scanner is destructed, so don't keep 'em around forever!

public:
    u32 GetNumEntries();
        // GetNumEntries() returns the number of entries found during the directory scan.
        
    const char * GetEntry(u32 nIndex);
        // GetEntry() returns the name of the entry found at index nIndex.
        // Entries are sorted alphabetically.
        // NOTE: do not cache the const char * returned from GetEntry() as it will
        // be freed when this is destructed.

private:
    void * m_pDirScannerInternal;
};

#endif // #ifndef _ROKU_INCLUDE_CASCADE_UTIL_CASCADEDIRSCANNER_H

// LOG
//  28-Jan-03   dwoodward       created

---