C# Class ICSharpCode.SharpZipLib.Core.FileSystemScanner

FileSystemScanner provides facilities scanning of files and directories.
Show file Open project: icsharpcode/SharpZipLib Class Usage Examples

Public Properties

Property Type Description
CompletedFile CompletedFileHandler
DirectoryFailure DirectoryFailureHandler
FileFailure FileFailureHandler
ProcessFile ProcessFileHandler

Public Methods

Method Description
FileSystemScanner ( IScanFilter fileFilter ) : System

Initialise a new instance of

FileSystemScanner ( IScanFilter fileFilter, IScanFilter directoryFilter ) : System

Initialise a new instance of

FileSystemScanner ( string filter ) : System

Initialise a new instance of

FileSystemScanner ( string fileFilter, string directoryFilter ) : System

Initialise a new instance of

OnCompleteFile ( string file ) : void

Raise the complete file event

OnProcessDirectory ( string directory, bool hasMatchingFiles ) : void

Raise the ProcessDirectory event.

OnProcessFile ( string file ) : void

Raise the ProcessFile event.

Scan ( string directory, bool recurse ) : void

Scan a directory.

ScanDir ( string directory, bool recurse ) : void

Private Methods

Method Description
OnDirectoryFailure ( string directory, Exception e ) : bool

Raise the DirectoryFailure event.

OnFileFailure ( string file, Exception e ) : bool

Raise the FileFailure event.

Method Details

FileSystemScanner() public method

Initialise a new instance of
public FileSystemScanner ( IScanFilter fileFilter ) : System
fileFilter IScanFilter The file filter to apply.
return System

FileSystemScanner() public method

Initialise a new instance of
public FileSystemScanner ( IScanFilter fileFilter, IScanFilter directoryFilter ) : System
fileFilter IScanFilter The file filter to apply.
directoryFilter IScanFilter The directory filter to apply.
return System

FileSystemScanner() public method

Initialise a new instance of
public FileSystemScanner ( string filter ) : System
filter string The file filter to apply when scanning.
return System

FileSystemScanner() public method

Initialise a new instance of
public FileSystemScanner ( string fileFilter, string directoryFilter ) : System
fileFilter string The file filter to apply.
directoryFilter string The directory filter to apply.
return System

OnCompleteFile() public method

Raise the complete file event
public OnCompleteFile ( string file ) : void
file string The file name
return void

OnProcessDirectory() public method

Raise the ProcessDirectory event.
public OnProcessDirectory ( string directory, bool hasMatchingFiles ) : void
directory string The directory name.
hasMatchingFiles bool Flag indicating if the directory has matching files.
return void

OnProcessFile() public method

Raise the ProcessFile event.
public OnProcessFile ( string file ) : void
file string The file name.
return void

Scan() public method

Scan a directory.
public Scan ( string directory, bool recurse ) : void
directory string The base directory to scan.
recurse bool True to recurse subdirectories, false to scan a single directory.
return void

ScanDir() public method

public ScanDir ( string directory, bool recurse ) : void
directory string
recurse bool
return void

Property Details

CompletedFile public property

Delegate to invoke when processing for a file has finished.
public CompletedFileHandler CompletedFile
return CompletedFileHandler

DirectoryFailure public property

Delegate to invoke when a directory failure is detected.
public DirectoryFailureHandler DirectoryFailure
return DirectoryFailureHandler

FileFailure public property

Delegate to invoke when a file failure is detected.
public FileFailureHandler FileFailure
return FileFailureHandler

ProcessFile public property

Delegate to invoke when a file is processed.
public ProcessFileHandler ProcessFile
return ProcessFileHandler