AgateLib.Utility.FileSystemProvider Class Reference

FileSystemProvider implements IFileProvider, providing access to files from the operating system file system. More...

Inheritance diagram for AgateLib.Utility.FileSystemProvider:

AgateLib.IFileProvider

List of all members.

Public Member Functions

 FileSystemProvider (string path)
 Constructs a FileSystemProvider object directing it to read files from the specified path.
Stream OpenRead (string filename)
 Opens a file.
bool FileExists (string filename)
 Returns true if the specified file exists.
IEnumerable< string > GetAllFiles ()
 Gets all files in all paths.
IEnumerable< string > GetAllFiles (string searchPattern)
 Gets all files in all paths that match the specified search pattern.
override string ToString ()
 Returns a string representing the FileSystemProvider object.

Properties

string SearchPath [get]
 Gets the path that this FileSystemProvider searches in.


Detailed Description

FileSystemProvider implements IFileProvider, providing access to files from the operating system file system.


Constructor & Destructor Documentation

AgateLib.Utility.FileSystemProvider.FileSystemProvider ( string  path  ) 

Constructs a FileSystemProvider object directing it to read files from the specified path.

Parameters:
path 


Member Function Documentation

bool AgateLib.Utility.FileSystemProvider.FileExists ( string  filename  ) 

Returns true if the specified file exists.

Parameters:
filename 
Returns:

Implements AgateLib.IFileProvider.

IEnumerable<string> AgateLib.Utility.FileSystemProvider.GetAllFiles ( string  searchPattern  ) 

Gets all files in all paths that match the specified search pattern.

Parameters:
searchPattern 
Returns:

Implements AgateLib.IFileProvider.

IEnumerable<string> AgateLib.Utility.FileSystemProvider.GetAllFiles (  ) 

Gets all files in all paths.

Returns:

Implements AgateLib.IFileProvider.

Stream AgateLib.Utility.FileSystemProvider.OpenRead ( string  filename  ) 

Opens a file.

Parameters:
filename 
Returns:

Implements AgateLib.IFileProvider.

override string AgateLib.Utility.FileSystemProvider.ToString (  ) 

Returns a string representing the FileSystemProvider object.

Returns:


Property Documentation

string AgateLib.Utility.FileSystemProvider.SearchPath [get]

Gets the path that this FileSystemProvider searches in.


The documentation for this class was generated from the following file:
AgateLib
Awesome Game and Tool Engine Library
SourceForge.net Logo