ZipArchiveLib::CDirEnumerator Class Reference

#include <DirEnumerator.h>

List of all members.

Public Member Functions

LPCTSTR GetCurrentDirectory () const
LPCTSTR GetDirectory () const
bool IsRecursive () const
bool Start (CFileFilter &filter)

Protected Member Functions

 CDirEnumerator (LPCTSTR lpszDirectory, bool bRecursive=true)
virtual void EnterDirectory ()
virtual void ExitDirectory ()
virtual void OnEnumerationBegin ()
virtual void OnEnumerationEnd (bool bResult)
virtual bool Process (LPCTSTR lpszPath, const CFileInfo &info)=0


Detailed Description

A base class for processing multiple files in a directory. It provides a directory enumeration functionality.

Definition at line 46 of file DirEnumerator.h.


Constructor & Destructor Documentation

ZipArchiveLib::CDirEnumerator::CDirEnumerator ( LPCTSTR  lpszDirectory,
bool  bRecursive = true 
) [inline, protected]

Initializes a new CDirEnumerator object.

Parameters:
lpszDirectory A directory to process.
bRecursive The value indicating whether the subfolders of lpszDirectory should be processed recursively.
See also:
GetDirectory

IsRecursive

Definition at line 68 of file DirEnumerator.h.


Member Function Documentation

virtual void ZipArchiveLib::CDirEnumerator::EnterDirectory (  )  [inline, protected, virtual]

This method is called when an enumeration process enters a new directory.

See also:
GetCurrentDirectory

ExitDirectory

Definition at line 126 of file DirEnumerator.h.

virtual void ZipArchiveLib::CDirEnumerator::ExitDirectory (  )  [inline, protected, virtual]

This method is called when an enumeration process exits a directory.

See also:
GetCurrentDirectory

EnterDirectory

Definition at line 136 of file DirEnumerator.h.

LPCTSTR ZipArchiveLib::CDirEnumerator::GetCurrentDirectory (  )  const [inline]

Returns the directory being currently processed.

Returns:
The directory being currently processed.

Definition at line 169 of file DirEnumerator.h.

LPCTSTR ZipArchiveLib::CDirEnumerator::GetDirectory (  )  const [inline]

Returns the directory being enumerated.

Returns:
The directory being enumerated (root).
See also:
CDirEnumerator::CDirEnumerator

Definition at line 149 of file DirEnumerator.h.

bool ZipArchiveLib::CDirEnumerator::IsRecursive (  )  const [inline]

Returns the value indicating whether the subfolders of the root directory are processed recursively.

Returns:
true, if the enumeration process is recursive; false otherwise.
See also:
CDirEnumerator::CDirEnumerator

Definition at line 161 of file DirEnumerator.h.

virtual void ZipArchiveLib::CDirEnumerator::OnEnumerationBegin (  )  [inline, protected, virtual]

This method is called at the beginning of the enumeration process.

See also:
OnEnumerationEnd

Definition at line 104 of file DirEnumerator.h.

virtual void ZipArchiveLib::CDirEnumerator::OnEnumerationEnd ( bool  bResult  )  [inline, protected, virtual]

This method is called at the end of the enumeration process.

Parameters:
bResult It is set to false, if the Process method returned false (the enumeration was aborted). Otherwise, it is set to true.
See also:
OnEnumerationBegin

Definition at line 116 of file DirEnumerator.h.

virtual bool ZipArchiveLib::CDirEnumerator::Process ( LPCTSTR  lpszPath,
const CFileInfo info 
) [protected, pure virtual]

Override this method to perform file processing while enumerating directories. This method is not called for directories, but for files only.

Parameters:
lpszPath The full path to the current file.
info A structure containing an information about the current file.
Returns:
Return true to continue the enumeration. When you return false, the enumeration is aborted.
See also:
CFileFilter::Evaluate

bool ZipArchiveLib::CDirEnumerator::Start ( CFileFilter filter  ) 

Starts the enumeration process. Calls CFileFilter::Evaluate method for every file or directory found. If CFileFilter::Evaluate returns true, the file is processed by the Process method.

Parameters:
filter A filter that decides which directories and/or files should be processed and which should not.
Returns:
false, if the process was aborted (the Process method returned false); true otherwise.
See also:
CFileFilter::Evaluate


The documentation for this class was generated from the following file:

The ZipArchive Library Copyright © 2000 - 2009 Artpol Software - Tadeusz Dracz. Generated at Fri Apr 24 16:46:41 2009.