ICSharpCode::SharpZipLib::Core::FileSystemScanner Class Reference

FileSystemScanner provides facilities scanning of files and directories. More...

List of all members.

Public Member Functions

 FileSystemScanner (string filter)
 Initialise a new instance of FileSystemScanner.
 FileSystemScanner (string fileFilter, string directoryFilter)
 Initialise a new instance of FileSystemScanner.
 FileSystemScanner (IScanFilter fileFilter)
 Initialise a new instance of FileSystemScanner.
 FileSystemScanner (IScanFilter fileFilter, IScanFilter directoryFilter)
 Initialise a new instance of FileSystemScanner.
void OnDirectoryFailure (string directory, Exception e)
 Raise the DirectoryFailure event.
void OnFileFailure (string file, Exception e)
 Raise the FileFailure event.
void OnProcessFile (string file)
 Raise the ProcessFile event.
void OnProcessDirectory (string directory, bool hasMatchingFiles)
 Raise the ProcessDirectory event.
void Scan (string directory, bool recurse)
 Scan a directory.

Public Attributes

ProcessDirectoryDelegate ProcessDirectory
 Delegate to invoke when a directory is processed.
ProcessFileDelegate ProcessFile
 Delegate to invoke when a file is processed.
DirectoryFailureDelegate DirectoryFailure
 Delegate to invoke when a directory failure is detected.
FileFailureDelegate FileFailure
 Delegate to invoke when a file failure is detected.

Private Member Functions

void ScanDir (string directory, bool recurse)

Private Attributes

IScanFilter fileFilter
 The file filter currently in use.
IScanFilter directoryFilter
 The directory filter currently in use.
bool alive
 Falg indicating if scanning is still alive. Used to cancel a scan.


Detailed Description

FileSystemScanner provides facilities scanning of files and directories.

Definition at line 178 of file FileSystemScanner.cs.


Constructor & Destructor Documentation

ICSharpCode::SharpZipLib::Core::FileSystemScanner::FileSystemScanner string  filter  )  [inline]
 

Initialise a new instance of FileSystemScanner.

Parameters:
filter The file filter to apply when scanning.

Definition at line 184 of file FileSystemScanner.cs.

ICSharpCode::SharpZipLib::Core::FileSystemScanner::FileSystemScanner string  fileFilter,
string  directoryFilter
[inline]
 

Initialise a new instance of FileSystemScanner.

Parameters:
fileFilter The file NameFilterfilter to apply.
directoryFilter The directory NameFilterfilter to apply.

Definition at line 194 of file FileSystemScanner.cs.

ICSharpCode::SharpZipLib::Core::FileSystemScanner::FileSystemScanner IScanFilter  fileFilter  )  [inline]
 

Initialise a new instance of FileSystemScanner.

Parameters:
fileFilter The file NameFilterfilter to apply.

Definition at line 204 of file FileSystemScanner.cs.

ICSharpCode::SharpZipLib::Core::FileSystemScanner::FileSystemScanner IScanFilter  fileFilter,
IScanFilter  directoryFilter
[inline]
 

Initialise a new instance of FileSystemScanner.

Parameters:
fileFilter The file IScanFilterfilter to apply.
directoryFilter The directory IScanFilterfilter to apply.

Definition at line 214 of file FileSystemScanner.cs.


Member Function Documentation

void ICSharpCode::SharpZipLib::Core::FileSystemScanner::OnDirectoryFailure string  directory,
Exception  e
[inline]
 

Raise the DirectoryFailure event.

Parameters:
directory Rhe directory name.
e The exception detected.

Definition at line 245 of file FileSystemScanner.cs.

References ICSharpCode::SharpZipLib::Core::ScanFailureEventArgs::ContinueRunning.

void ICSharpCode::SharpZipLib::Core::FileSystemScanner::OnFileFailure string  file,
Exception  e
[inline]
 

Raise the FileFailure event.

Parameters:
file The file name.
e The exception detected.

Definition at line 261 of file FileSystemScanner.cs.

References ICSharpCode::SharpZipLib::Core::ScanFailureEventArgs::ContinueRunning.

void ICSharpCode::SharpZipLib::Core::FileSystemScanner::OnProcessDirectory string  directory,
bool  hasMatchingFiles
[inline]
 

Raise the ProcessDirectory event.

Parameters:
directory The directory name.
hasMatchingFiles Flag indicating if the directory has matching files.

Definition at line 290 of file FileSystemScanner.cs.

References ICSharpCode::SharpZipLib::Core::ScanEventArgs::ContinueRunning.

void ICSharpCode::SharpZipLib::Core::FileSystemScanner::OnProcessFile string  file  )  [inline]
 

Raise the ProcessFile event.

Parameters:
file The file name.

Definition at line 276 of file FileSystemScanner.cs.

References ICSharpCode::SharpZipLib::Core::ScanEventArgs::ContinueRunning.

void ICSharpCode::SharpZipLib::Core::FileSystemScanner::Scan string  directory,
bool  recurse
[inline]
 

Scan a directory.

Parameters:
directory The base directory to scan.
recurse True to recurse subdirectories, false to do a single directory.

Definition at line 304 of file FileSystemScanner.cs.

Referenced by ICSharpCode::SharpZipLib::Zip::FastZip::CreateZip().

void ICSharpCode::SharpZipLib::Core::FileSystemScanner::ScanDir string  directory,
bool  recurse
[inline, private]
 

Definition at line 310 of file FileSystemScanner.cs.


Member Data Documentation

bool ICSharpCode::SharpZipLib::Core::FileSystemScanner::alive [private]
 

Falg indicating if scanning is still alive. Used to cancel a scan.

Definition at line 377 of file FileSystemScanner.cs.

DirectoryFailureDelegate ICSharpCode::SharpZipLib::Core::FileSystemScanner::DirectoryFailure
 

Delegate to invoke when a directory failure is detected.

Definition at line 233 of file FileSystemScanner.cs.

IScanFilter ICSharpCode::SharpZipLib::Core::FileSystemScanner::directoryFilter [private]
 

The directory filter currently in use.

Definition at line 373 of file FileSystemScanner.cs.

FileFailureDelegate ICSharpCode::SharpZipLib::Core::FileSystemScanner::FileFailure
 

Delegate to invoke when a file failure is detected.

Definition at line 238 of file FileSystemScanner.cs.

IScanFilter ICSharpCode::SharpZipLib::Core::FileSystemScanner::fileFilter [private]
 

The file filter currently in use.

Definition at line 369 of file FileSystemScanner.cs.

ProcessDirectoryDelegate ICSharpCode::SharpZipLib::Core::FileSystemScanner::ProcessDirectory
 

Delegate to invoke when a directory is processed.

Definition at line 223 of file FileSystemScanner.cs.

Referenced by ICSharpCode::SharpZipLib::Zip::FastZip::CreateZip().

ProcessFileDelegate ICSharpCode::SharpZipLib::Core::FileSystemScanner::ProcessFile
 

Delegate to invoke when a file is processed.

Definition at line 228 of file FileSystemScanner.cs.

Referenced by ICSharpCode::SharpZipLib::Zip::FastZip::CreateZip().


The documentation for this class was generated from the following file:
Generated on Fri Jun 23 21:50:05 2006 for OblivionModTranslator by  doxygen 1.4.6-NO