AgateLib.Utility.SearchPathList Class Reference

A class which is used to simplify searching for files in several different directories. All paths entered are stored as absolute paths, so do not expect to add an item and retrieve it and have it be the same thing.

. More...

Inheritance diagram for AgateLib.Utility.SearchPathList:

List of all members.

Public Member Functions

SearchPathList ()

Constructs a SearchPathList object. No default paths are added (You might want to consider using SearchPathList(".") instead to include the current directory.).

SearchPathList (params string[] array)

Constructs a SearchPathList object, and adds all the paths specified to the list of paths to search.

override string ToString ()

Provides debugging information.

void Add (string item)

Adds a search path to the list.

void Clear ()

Clears all search paths from the list.

bool Contains (string item)

Checks to see if the given path is already in the list.

void CopyTo (string[] array, int arrayIndex)

Copies the list of paths to an array.

bool Remove (string item)

Removes an item from the search path list.

IEnumerator< string > GetEnumerator ()

Gets an IEnumerator<string> object for iterating through the search paths.

Properties

int Count [get]

Gets how many search paths are listed here.

string this [int index] [get, set]

Returns a search path at a given index.

Detailed Description

A class which is used to simplify searching for files in several different directories. All paths entered are stored as absolute paths, so do not expect to add an item and retrieve it and have it be the same thing.

.

Constructor & Destructor Documentation

AgateLib.Utility.SearchPathList.SearchPathList ( )

Constructs a SearchPathList object. No default paths are added (You might want to consider using SearchPathList(".") instead to include the current directory.).

AgateLib.Utility.SearchPathList.SearchPathList ( params string[] array )

Constructs a SearchPathList object, and adds all the paths specified to the list of paths to search.

Parameters:

array

A comma delimited list of strings.

Member Function Documentation

void AgateLib.Utility.SearchPathList.Add ( string item )

Adds a search path to the list.

Parameters:

item

void AgateLib.Utility.SearchPathList.Clear ( )

Clears all search paths from the list.

bool AgateLib.Utility.SearchPathList.Contains ( string item )

Checks to see if the given path is already in the list.

Parameters:

item

Returns:

void AgateLib.Utility.SearchPathList.CopyTo	(	string[]	array,
		int	arrayIndex
	)

Copies the list of paths to an array.

Parameters:

	array
	arrayIndex

IEnumerator<string> AgateLib.Utility.SearchPathList.GetEnumerator ( )

Gets an IEnumerator<string> object for iterating through the search paths.

Returns:

bool AgateLib.Utility.SearchPathList.Remove ( string item )

Removes an item from the search path list.

Parameters:

item

Returns:

override string AgateLib.Utility.SearchPathList.ToString ( )

Provides debugging information.

Returns:

Property Documentation

int AgateLib.Utility.SearchPathList.Count [get]

Gets how many search paths are listed here.

string AgateLib.Utility.SearchPathList.this[int index] [get, set]

Returns a search path at a given index.

Parameters:

index

Returns:

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

Utility/SearchPathList.cs


Public Member Functions
	SearchPathList ()
	Constructs a SearchPathList object. No default paths are added (You might want to consider using SearchPathList(".") instead to include the current directory.).
	SearchPathList (params string[] array)
	Constructs a SearchPathList object, and adds all the paths specified to the list of paths to search.
override string	ToString ()
	Provides debugging information.
void	Add (string item)
	Adds a search path to the list.
void	Clear ()
	Clears all search paths from the list.
bool	Contains (string item)
	Checks to see if the given path is already in the list.
void	CopyTo (string[] array, int arrayIndex)
	Copies the list of paths to an array.
bool	Remove (string item)
	Removes an item from the search path list.
IEnumerator< string >	GetEnumerator ()
	Gets an IEnumerator<string> object for iterating through the search paths.
Properties
int	Count `[get]`
	Gets how many search paths are listed here.
string	this [int index] `[get, set]`
	Returns a search path at a given index.