AgateLib.Utility.FileManager Class Reference

Manages file locations and automatic finding of files. More...

List of all members.

Static Public Member Functions
static Stream	OpenFile (SearchPath path, string filename, FileMode mode, FileAccess access)
	Opens an existing file.
Properties
static string	PathChars [get, set]
	Indicates the characters that the application can use to specify directories, when using methods in this class to open files.
static SearchPath	AssemblyPath [get, set]
	Gets or sets the SearchPath object which contains the paths used for finding assemblies. Defaults to containing only the directory where the application executable is located.
static SearchPath	ImagePath [get, set]
	Gets or sets the SearchPath object which contains the paths used for finding images. Defaults to containing only the current directory.
static SearchPath	SoundPath [get, set]
	Gets or sets the SearchPath object which contains the paths used for finding sound files. Defaults to containing only the current directory.
static SearchPath	MusicPath [get, set]
	Gets or sets the SearchPath object which contains the paths used for finding music files. Defaults to containing only the current directory.
static SearchPath	ResourcePath [get, set]
	Gets or sets the SearchPath object which contains the paths used for finding resource definition files. Defaults to containing only the current directory.
static bool	BufferStreams [get, set]
	Gets or sets a boolean value indicating whether or not streams created by the FileManager should be wrapped in a BufferedStream object.
static int	BufferSize [get, set]
	Gets or sets how large of a buffer should be used if BufferStreams is true.

---

Detailed Description

Manages file locations and automatic finding of files.

e

---

Member Function Documentation

static Stream AgateLib.Utility.FileManager.OpenFile	(	SearchPath	path,
		string	filename,
		FileMode	mode,
		FileAccess	access
	)			[static]

Opens an existing file.

Parameters:

	path
	filename
	mode
	access

Returns:

---

Property Documentation

SearchPath AgateLib.Utility.FileManager.AssemblyPath [static, get, set]

Gets or sets the SearchPath object which contains the paths used for finding assemblies. Defaults to containing only the directory where the application executable is located.

int AgateLib.Utility.FileManager.BufferSize [static, get, set]

Gets or sets how large of a buffer should be used if BufferStreams is true.

bool AgateLib.Utility.FileManager.BufferStreams [static, get, set]

Gets or sets a boolean value indicating whether or not streams created by the FileManager should be wrapped in a BufferedStream object.

SearchPath AgateLib.Utility.FileManager.ImagePath [static, get, set]

Gets or sets the SearchPath object which contains the paths used for finding images. Defaults to containing only the current directory.

SearchPath AgateLib.Utility.FileManager.MusicPath [static, get, set]

Gets or sets the SearchPath object which contains the paths used for finding music files. Defaults to containing only the current directory.

string AgateLib.Utility.FileManager.PathChars [static, get, set]

Indicates the characters that the application can use to specify directories, when using methods in this class to open files.

Defaults to "/".

SearchPath AgateLib.Utility.FileManager.ResourcePath [static, get, set]

Gets or sets the SearchPath object which contains the paths used for finding resource definition files. Defaults to containing only the current directory.

SearchPath AgateLib.Utility.FileManager.SoundPath [static, get, set]

Gets or sets the SearchPath object which contains the paths used for finding sound files. Defaults to containing only the current directory.

---

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

• Utility/FileManager.cs