C# Class ChinhDo.Transactions.TxFileManager

File Resource Manager. Allows inclusion of file system operations in transactions. http://www.chinhdo.com/20080825/transactional-file-manager/

Inheritance: IFileManager

Show file Open project: NexusMods/NexusModManager-4.5 Class Usage Examples

Public Methods

Method	Description
AppendAllText ( string path, string contents ) : void	Appends the specified string the file, creating the file if it doesn't already exist.
Copy ( string sourceFileName, string destFileName, bool overwrite ) : void	Copies the specified sourceFileName to destFileName.
CreateDirectory ( string path ) : void	Creates all directories in the specified path.
Delete ( string path ) : void	Deletes the specified file. An exception is not thrown if the file does not exist.
DirectoryExists ( string path ) : bool	Determines whether the specified path refers to a directory that exists on disk.
FileExists ( string path ) : bool	Determines whether the specified file exists.
GetFiles ( string path, FileEventHandler handler, bool recursive ) : void	Gets the files in the specified directory.
GetGuid ( ) : System.Guid	Gets a GUID.
GetTempDirectory ( ) : string	Gets a temporary directory.
GetTempDirectory ( string parentDirectory, string prefix ) : string	Gets a temporary directory.
GetTempFileName ( ) : string	Creates a temporary file name. File is not automatically created.
GetTempFileName ( string extension ) : string	Creates a temporary file name. File is not automatically created.
Move ( string srcFileName, string destFileName ) : void	Moves the specified file to a new location.
Snapshot ( string fileName ) : void	Take a snapshot of the specified file. The snapshot is used to rollback the file later if needed.
WriteAllBytes ( string path, byte contents ) : void	Creates a file, and writes the specified contents to the file. If the file already exists, it is overwritten.
WriteAllText ( string path, string contents ) : void	Creates a file, write the specified contents to the file.

Private Methods

Method	Description
GetEnlistment ( ) : ChinhDo.Transactions.TxEnlistment
TxFileManager ( ) : System	Initializes the TxFileManager class.

Method Details

AppendAllText() public method

Appends the specified string the file, creating the file if it doesn't already exist.

public AppendAllText ( string path, string contents ) : void
path	string	The file to append the string to.
contents	string	The string to append to the file.
return	void

Copy() public method

Copies the specified sourceFileName to destFileName.

public Copy ( string sourceFileName, string destFileName, bool overwrite ) : void
sourceFileName	string	The file to copy.
destFileName	string	The name of the destination file.
overwrite	bool	true if the destination file can be overwritten, otherwise false.
return	void

CreateDirectory() public method

Creates all directories in the specified path.

public CreateDirectory ( string path ) : void
path	string	The directory path to create.
return	void

Delete() public method

Deletes the specified file. An exception is not thrown if the file does not exist.

public Delete ( string path ) : void
path	string	The file to be deleted.
return	void

DirectoryExists() public method

Determines whether the specified path refers to a directory that exists on disk.

public DirectoryExists ( string path ) : bool
path	string	The directory to check.
return	bool

FileExists() public method

Determines whether the specified file exists.

public FileExists ( string path ) : bool
path	string	The file to check.
return	bool

GetFiles() public method

Gets the files in the specified directory.

public GetFiles ( string path, FileEventHandler handler, bool recursive ) : void
path	string	The directory to get files.
handler	FileEventHandler	The object to call on each file found.
recursive	bool	if set to true, include files in sub directories recursively.
return	void

GetGuid() public static method

Gets a GUID.

public static GetGuid ( ) : System.Guid
return	System.Guid

GetTempDirectory() public method

Gets a temporary directory.

public GetTempDirectory ( ) : string
return	string

GetTempDirectory() public method

Gets a temporary directory.

public GetTempDirectory ( string parentDirectory, string prefix ) : string
parentDirectory	string	The parent directory.
prefix	string	The prefix of the directory name.
return	string

GetTempFileName() public method

Creates a temporary file name. File is not automatically created.

public GetTempFileName ( ) : string
return	string

GetTempFileName() public method

Creates a temporary file name. File is not automatically created.

public GetTempFileName ( string extension ) : string
extension	string	File extension (with the dot).
return	string

Move() public method

Moves the specified file to a new location.

public Move ( string srcFileName, string destFileName ) : void
srcFileName	string	The name of the file to move.
destFileName	string	The new path for the file.
return	void

Snapshot() public method

Take a snapshot of the specified file. The snapshot is used to rollback the file later if needed.

public Snapshot ( string fileName ) : void
fileName	string	The file to take a snapshot for.
return	void

WriteAllBytes() public method

Creates a file, and writes the specified contents to the file. If the file already exists, it is overwritten.

public WriteAllBytes ( string path, byte contents ) : void
path	string	The file to write to.
contents	byte	The bytes to write to the file.
return	void

WriteAllText() public method

Creates a file, write the specified contents to the file.

public WriteAllText ( string path, string contents ) : void
path	string	The file to write to.
contents	string	The string to write to the file.
return	void