aendenne

aendennehttp://footheory.com/blogs/aendenne/default.aspxenCommunityServer 2007 SP2 (Debug Build: 20611.960)File Manipulation in C#http://footheory.com/blogs/aendenne/archive/2007/09/25/file-manipulation-in-c.aspxWed, 26 Sep 2007 05:07:00 GMT9ce7e6ef-4587-4f0e-939d-3f75f3a8ddfc:186aendenne1http://footheory.com/blogs/aendenne/rsscomments.aspx?PostID=186http://footheory.com/blogs/aendenne/archive/2007/09/25/file-manipulation-in-c.aspx#commentsA couple of the methods I have used most in the following code segment return a List object, or an ArrayList of text found inside a file to inspect. Other methods that I've used a lot edit an existing file from a specific line number, or retrieve the full text from a specific file. I've overloaded the AddToFile() method to allow varying ways to edit a file. Let me know if you extend this tool; I like collaboration.  -aendenne   /*<o:p></o:p>  * Author: aendenne<o:p></o:p>  * Email: AutomateAnything@yahoo.com<o:p></o:p>  * Create Date: April 21, 2007<o:p></o:p>  * Last Modified Date: September 25, 2007<o:p></o:p>  * Version: 1.1<o:p></o:p>  */<o:p> </o:p> using System;<o:p></o:p> using System.Collections;<o:p></o:p> using System.Collections.Generic;<o:p></o:p> using System.IO;<o:p> </o:p> namespace YourNamespace.Tools<o:p></o:p> {<o:p></o:p>     /// <summary><o:p></o:p>     /// Class that stores static methods to create, access,<o:p></o:p>     /// (especially read from) and manipulate files<o:p></o:p>     /// </summary><o:p></o:p>     /// <remarks><o:p></o:p>     /// does NOT include good error-handling. this is not a  <o:p></o:p>     /// recommended practice, please extend the try/catch statements...<o:p></o:p>     /// i will post a simple error tool soon.<o:p></o:p>     /// </remarks><o:p></o:p>     public class FileTool<o:p></o:p>     {<o:p></o:p>         /// <summary><o:p></o:p>         /// string constant to store message to return<o:p></o:p>         /// if file exists, and user does NOT wish to override<o:p></o:p>         /// </summary><o:p></o:p>         private const string m_FileExistsMessage = <o:p></o:p>             "The file already exists: ";<o:p> </o:p>         /// <summary><o:p></o:p>         /// Gets string indicating the current directory<o:p></o:p>         /// </summary><o:p></o:p>         /// <returns>string value of the current directory</returns><o:p></o:p>         public static string GetCurrentDirectory()<o:p></o:p>         {<o:p></o:p>             try<o:p></o:p>             {<o:p></o:p>                 return Directory.GetCurrentDirectory().ToString();<o:p></o:p>             }<o:p></o:p>             catch (Exception ex)<o:p></o:p>             {<o:p></o:p>                 //ErrorTool.ProcessError(ex);<o:p></o:p>                 //return null;<o:p></o:p>                 throw (ex);<o:p></o:p>             }<o:p></o:p>         }<o:p> </o:p>         /// <summary><o:p></o:p>         /// Creates a file in path suggested, and writes the<o:p></o:p>         /// contents to that file<o:p></o:p>         /// </summary><o:p></o:p>         /// <param name="path"><o:p></o:p>         /// string value indicating path (include file name)<o:p></o:p>         /// to store new file in<o:p></o:p>         /// </param><o:p></o:p>         /// <param name="contents"><o:p></o:p>         /// string value storing the contents to write<o:p></o:p>         /// to the new file<o:p></o:p>         /// </param><o:p></o:p>         /// <param name="overwrite"><o:p></o:p>         /// bool value indicating whether to replace file in path <o:p></o:p>         /// if one already exists at that location<o:p></o:p>         /// </param><o:p></o:p>         public static void WriteNewFile(string path, <o:p></o:p>             string contents, bool overwrite)<o:p></o:p>         {<o:p></o:p>             try<o:p></o:p>             {<o:p></o:p>                 CreateNewFile(path, overwrite);<o:p></o:p>                 AddToFile(path, contents, true);<o:p></o:p>             }<o:p></o:p>             catch (Exception ex)<o:p></o:p>             {<o:p></o:p>                 //ErrorTool.ProcessError(ex);<o:p></o:p>                 //return;<o:p></o:p>                 throw (ex);<o:p></o:p>             }<o:p></o:p>         }<o:p> </o:p>         /// <summary><o:p></o:p>         /// Creates a file at the indicated path<o:p></o:p>         /// </summary><o:p></o:p>         /// <param name="path"><o:p></o:p>         /// string value indicating where to store<o:p></o:p>         /// the new file (include file name)<o:p></o:p>         /// </param><o:p></o:p>         /// <param name="overwrite"><o:p></o:p>         /// bool value indicating whether to replace file in path<o:p></o:p>         /// if one already exists at that location<o:p></o:p>         /// </param>         /// <returns><o:p></o:p>         /// bool value indicating whether file was created<o:p></o:p>         /// </returns><o:p></o:p><o:p></o:p>         public static bool CreateNewFile(string path, bool overwrite)<o:p></o:p>         {<o:p></o:p>             try<o:p></o:p>             {<o:p></o:p>                 if (File.Exists(path) && !overwrite)<o:p></o:p>                 {<o:p></o:p>                     //Exception ex = new Exception(m_FileExistsMessage);<o:p></o:p>                     //ErrorTool.ProcessError(ex);<o:p></o:p>                     <o:p></o:p>                     return false;<o:p></o:p>                 }<o:p></o:p>                 FileStream file = new FileStream(<o:p></o:p>                     path, FileMode.Create);<o:p></o:p>                 file.Close();                return true;             }<o:p></o:p>             catch (Exception ex)<o:p></o:p>             {<o:p></o:p>                 //ErrorTool.ProcessError(ex);<o:p></o:p>                 //return false;<o:p></o:p>                 throw(ex); <o:p></o:p>             }<o:p></o:p>         }<o:p> </o:p>         /// <summary><o:p></o:p>         /// Deletes the file indicated from the system<o:p></o:p>         /// </summary><o:p></o:p>         /// <param name="path"><o:p></o:p>         /// string value indicating full file path to delete<o:p></o:p>         /// </param><o:p></o:p>         private static void m_DeleteFile(string path)<o:p></o:p>         {<o:p></o:p>             try<o:p></o:p>             {<o:p></o:p>                 if (!File.Exists(path))<o:p></o:p>                     return;<o:p></o:p>                 File.Delete(path);<o:p></o:p>             }<o:p></o:p>             catch (Exception ex)<o:p></o:p>             {<o:p></o:p>                 //ErrorTool.ProcessError(ex);<o:p></o:p>                 //return;<o:p></o:p>                 throw (ex);<o:p></o:p>             }<o:p></o:p>         }<o:p> </o:p>         /// <summary><o:p></o:p>         /// Checks path to be sure it's a file, and if so,<o:p></o:p>         /// makes that file writeable (may have been read-only...)<o:p></o:p>         /// </summary><o:p></o:p>         /// <param name="path"><o:p></o:p>         /// string path/filename to set as editable<o:p></o:p>         /// </param><o:p></o:p>         private static void m_MakeEditable(string path)<o:p></o:p>         {<o:p></o:p>             try<o:p></o:p>             {<o:p></o:p>                 if (!File.Exists(path))<o:p></o:p>                 {<o:p></o:p>                     return; //filepath doesn't exist<o:p></o:p>                 }<o:p> </o:p>                 FileAttributes attributes = File.GetAttributes(path);<o:p> </o:p>                 if ((attributes & FileAttributes.Directory) != 0)<o:p></o:p>                 {<o:p></o:p>                     return; //it's a directory/folder<o:p></o:p>                 }<o:p></o:p>                 attributes = FileAttributes.Normal;<o:p></o:p>                 File.SetAttributes(path, attributes);<o:p></o:p>             }<o:p></o:p>             catch (Exception ex)<o:p></o:p>             {<o:p></o:p>                 //ErrorTool.ProcessError(ex);<o:p></o:p>                 //return;<o:p></o:p>                 throw (ex);<o:p></o:p>             }<o:p></o:p>         }<o:p></o:p>               <o:p></o:p>         /// <summary><o:p></o:p>         /// Opens and existing file, and adds to its contents<o:p></o:p>         /// </summary><o:p></o:p>         /// <param name="path"><o:p></o:p>         /// string value: full path/filename to add to<o:p></o:p>         /// </param><o:p></o:p>         /// <param name="appendage"><o:p></o:p>         /// string value: stream of characters/words to add<o:p></o:p>         /// </param><o:p></o:p>         /// <param name="newLine"><o:p></o:p>         /// bool value indicating whether to start at a new line<o:p></o:p>         /// </param><o:p></o:p>         public static void AddToFile(string path, <o:p></o:p>             string appendage, bool newLine)<o:p></o:p>         {<o:p></o:p>             try<o:p></o:p>             {<o:p></o:p>                 StreamWriter writer = File.AppendText(path);<o:p></o:p>                 if (newLine)<o:p></o:p>                 {<o:p></o:p>                     writer.WriteLine();<o:p></o:p>                 }<o:p></o:p>                 writer.Write(appendage);<o:p></o:p>                 writer.Close();<o:p></o:p>             }<o:p></o:p>             catch (Exception ex)<o:p></o:p>             {<o:p></o:p>                 //ErrorTool.ProcessError(ex);<o:p></o:p>                 //return;<o:p></o:p>                 throw (ex);<o:p></o:p>             }<o:p></o:p>         }<o:p> </o:p>         /// <summary><o:p></o:p>         /// Opens a file and adds the supplied text<o:p></o:p>         /// to that file at the specified line number<o:p></o:p>         /// </summary><o:p></o:p>         /// <param name="path"><o:p></o:p>         /// String indicating the file path, including<o:p></o:p>         /// the name of the file<o:p></o:p>         /// </param><o:p></o:p>         /// <param name="textToInsert"><o:p></o:p>         /// String to insert/add to the file<o:p></o:p>         /// </param><o:p></o:p>         /// <param name="lineNumber"><o:p></o:p>         /// Zero-based line number----if the text should<o:p></o:p>         /// be added at line 10, then pass 9<o:p></o:p>         /// </param><o:p></o:p>         public static void AddToFile(string path, <o:p></o:p>             string textToInsert, int lineNumber)<o:p></o:p>         {<o:p></o:p>             try<o:p></o:p>             {<o:p></o:p>                 ArrayList lines = GetLinesFromFile(path);<o:p> </o:p>                 if (lines.Count > lineNumber)<o:p></o:p>                 {<o:p></o:p>                     lines.Insert(lineNumber, textToInsert);<o:p></o:p>                 }<o:p></o:p>                 else<o:p></o:p>                 {<o:p></o:p>                     lines.Add(textToInsert);<o:p></o:p>                 }<o:p> </o:p>                 StreamWriter writer = new StreamWriter(path);<o:p> </o:p>                 foreach (string lineToWrite in lines)<o:p></o:p>                 {<o:p></o:p>                     writer.WriteLine(lineToWrite);<o:p></o:p>                 }<o:p></o:p>                 writer.Close();<o:p></o:p>             }<o:p></o:p>             catch (Exception ex)<o:p></o:p>             {<o:p></o:p>                 //ErrorTool.ProcessError(ex);<o:p></o:p>                 //return;<o:p></o:p>                 throw (ex);<o:p></o:p>             }<o:p></o:p>         }<o:p> </o:p>         /// <summary><o:p></o:p>         /// Opens a file and adds the supplied text<o:p></o:p>         /// to that file after the first line found, <o:p></o:p>         /// that contains the textToInsertAfter string. <o:p></o:p>         /// Will add at 0 (first line), if not found at all.<o:p></o:p>         /// </summary><o:p></o:p>         /// <param name="path"><o:p></o:p>         /// String indicating the file path, including<o:p></o:p>         /// the name of the file<o:p></o:p>         /// </param><o:p></o:p>         /// <param name="textToInsert"><o:p></o:p>         /// String to insert/add to the file<o:p></o:p>         /// </param><o:p></o:p>         /// <param name="textToInsertAfter"><o:p></o:p>         /// Text to place the new string after, will be<o:p></o:p>         /// inserted on the next line<o:p></o:p>         /// </param><o:p></o:p>         public static void AddToFile(string path, <o:p></o:p>             string textToInsert, string textToInsertAfter)<o:p></o:p>         {<o:p></o:p>             try<o:p></o:p>             {<o:p></o:p>                 ArrayList lines = GetLinesFromFile(path);<o:p></o:p>                 int location = 0;<o:p></o:p>                 int currentLine = 0;<o:p></o:p>                 foreach (string lineToRead in lines)<o:p></o:p>                 {<o:p></o:p>                     if (lineToRead.Contains(textToInsertAfter))<o:p></o:p>                     {<o:p></o:p>                         location = currentLine + 1;<o:p></o:p>                     }<o:p></o:p>                     currentLine += 1;<o:p></o:p>                 }<o:p></o:p>                 lines.Insert(location, textToInsert);<o:p> </o:p>                 StreamWriter writer = new StreamWriter(path);<o:p> </o:p>                 foreach (string lineToWrite in lines)<o:p></o:p>                 {<o:p></o:p>                     writer.WriteLine(lineToWrite);<o:p></o:p>                 }<o:p></o:p>                 writer.Close();<o:p></o:p>             }<o:p></o:p>             catch (Exception ex)<o:p></o:p>             {<o:p></o:p>                 //ErrorTool.ProcessError(ex);<o:p></o:p>                 //return;<o:p></o:p>                 throw (ex);<o:p></o:p>             }<o:p></o:p>         }<o:p> </o:p>         /// <summary><o:p></o:p>         /// Opens and existing file, and adds to its contents<o:p></o:p>         /// (adds at the end of prior contents)<o:p></o:p>         /// </summary><o:p></o:p>         /// <param name="path"><o:p></o:p>         /// string value: full path/filename to add to<o:p></o:p>         /// </param><o:p></o:p>         /// <param name="appendage"><o:p></o:p>         /// string value: stream of characters/words to add<o:p></o:p>         /// </param><o:p></o:p>         public static void AddToFile(string path, string appendage)<o:p></o:p>         {<o:p></o:p>             try<o:p></o:p>             {<o:p></o:p>                 if (!File.Exists(path))<o:p></o:p>                 {<o:p></o:p>                     CreateNewFile(path, true);<o:p></o:p>                 }<o:p></o:p>                 AddToFile(path, appendage, true);<o:p></o:p>             }<o:p></o:p>             catch (Exception ex)<o:p></o:p>             {<o:p></o:p>                 //ErrorTool.ProcessError(ex);<o:p></o:p>                 //return;<o:p></o:p>                 throw (ex);<o:p></o:p>             }<o:p></o:p>         }<o:p> </o:p>         /// <summary><o:p></o:p>         /// Closes an open FileStream object<o:p></o:p>         /// </summary><o:p></o:p>         /// <param name="fileToClose">FileStream to close</param><o:p></o:p>         public static void CloseFile(FileStream fileToClose)<o:p></o:p>         {<o:p></o:p>             try<o:p></o:p>             {<o:p></o:p>                 fileToClose.Close();<o:p></o:p>             }<o:p></o:p>             catch (Exception ex)<o:p></o:p>             {<o:p></o:p>                 //ErrorTool.ProcessError(ex);<o:p></o:p>                 //return;<o:p></o:p>                 throw (ex);<o:p></o:p>             }<o:p></o:p>         }<o:p> </o:p>                 <o:p></o:p>/// <remarks>         /// USES A METHOD FROM <a href="http://footheory.com/blogs/aendenne/archive/2007/09/14/useful-string-functions-in-c.aspx">StringTool.cs</a>!         /// Will not compile/execute without that file,         /// so remove/comment this method if you don't have it                 <o:p></o:p>/// </remarks> <o:p></o:p>        /// <summary><o:p></o:p>         /// Checks for existence of a path<o:p></o:p>         /// </summary><o:p></o:p>         /// <param name="directoryPath"><o:p></o:p>         /// string value of path to check for<o:p></o:p>         /// </param><o:p></o:p>         /// <returns><o:p></o:p>         /// bool value indicating whether the requested path exists<o:p></o:p>         /// </returns><o:p></o:p>         public static bool CheckForDirectory(string directoryPath)<o:p></o:p>         {<o:p></o:p>             try<o:p></o:p>             {<o:p></o:p>                 string path = StringTool.GetFolderPath(directoryPath);<o:p></o:p>                 if (!Directory.Exists(path))<o:p></o:p>                 {<o:p></o:p>                     return false;<o:p></o:p>                 }<o:p></o:p>                 else<o:p></o:p>                 {<o:p></o:p>                     return true;<o:p></o:p>                 }<o:p></o:p>             }<o:p></o:p>             catch (Exception ex)<o:p></o:p>             {<o:p></o:p>                 //ErrorTool.ProcessError(ex);<o:p></o:p>                 //return;<o:p></o:p>                 throw (ex);<o:p></o:p>             }<o:p></o:p>         }<o:p> </o:p>                 <o:p></o:p>/// <remarks>         /// USES A METHOD FROM <a href="http://footheory.com/blogs/aendenne/archive/2007/09/14/useful-string-functions-in-c.aspx">StringTool.cs</a>!         /// Will not compile/execute without that file,         /// so remove/comment this method if you don't have it                 <o:p></o:p>/// </remarks> <o:p></o:p>        /// <summary><o:p></o:p>         /// Creates a directory (folder)<o:p></o:p>         /// </summary><o:p></o:p>         /// <param name="directoryPath"><o:p></o:p>         /// string value of path to create         /// </param>         public static void CreateDirectory(string directoryPath)<o:p></o:p>         {<o:p></o:p>             try<o:p></o:p>             {<o:p></o:p>                 string path = StringTool.GetFolderPath(directoryPath);<o:p> </o:p>                 if (Directory.Exists(directoryPath))<o:p></o:p>                 {<o:p></o:p>                     return;<o:p></o:p>                 }<o:p></o:p>                 Directory.CreateDirectory(path);<o:p></o:p>             }<o:p></o:p>             catch (Exception ex)<o:p></o:p>             {<o:p></o:p>                 //ErrorTool.ProcessError(ex);<o:p></o:p>                 //return;<o:p></o:p>                 throw (ex);<o:p></o:p>             }<o:p></o:p>         }<o:p> </o:p>                <o:p></o:p>/// <remarks>         /// USES A METHOD FROM <a href="http://footheory.com/blogs/aendenne/archive/2007/09/14/useful-string-functions-in-c.aspx">StringTool.cs</a>!         /// Will not compile/execute without that file,         /// so remove/comment this method if you don't have it                 <o:p></o:p>/// </remarks>         /// <summary><o:p></o:p>         /// Creates a directory (folder) inside the path indicated<o:p></o:p>         /// </summary><o:p></o:p>         /// <param name="directoryPath"><o:p></o:p>         /// string value of path to create<o:p></o:p>         /// </param><o:p></o:p>         /// <param name="folderName"><o:p></o:p>         /// string name of the folder to create<o:p></o:p>         /// </param><o:p></o:p>         public static void CreateDirectory(string directoryPath, <o:p></o:p>             string folderName)<o:p></o:p>         {<o:p></o:p>             try<o:p></o:p>             {<o:p></o:p>                 string path = StringTool.GetFolderPath(directoryPath);<o:p></o:p>                 path = path + folderName;<o:p> </o:p>                 if (Directory.Exists(directoryPath))<o:p></o:p>                 {<o:p></o:p>                     return;<o:p></o:p>                 }<o:p></o:p>                 Directory.CreateDirectory(path);<o:p></o:p>             }<o:p></o:p>             catch (Exception ex)<o:p></o:p>             {<o:p></o:p>                 //ErrorTool.ProcessError(ex);<o:p></o:p>                 //return;<o:p></o:p>                 throw (ex);<o:p></o:p>             }<o:p></o:p>         }<o:p> </o:p>         /// <summary><o:p></o:p>         /// Grabs an ArrayList of lines from filepath indicated<o:p></o:p>         /// </summary><o:p></o:p>         /// <param name="path"><o:p></o:p>         /// string value of filepath to get lines from<o:p></o:p>         /// </param><o:p></o:p>         /// <returns><o:p></o:p>         /// ArrayList object containing each string line in the file<o:p></o:p>         /// </returns><o:p></o:p>         public static ArrayList GetLinesFromFile(string path)<o:p></o:p>         {<o:p></o:p>             try<o:p></o:p>             {<o:p></o:p>                 ArrayList lines = new ArrayList();<o:p></o:p>                 StreamReader reader = new StreamReader(path);<o:p> </o:p>                 string currentLine = string.Empty;<o:p> </o:p>                 while ((currentLine = reader.ReadLine()) != null)<o:p></o:p>                 {<o:p></o:p>                     lines.Add(currentLine);<o:p></o:p>                 }<o:p></o:p>                 reader.Close();<o:p></o:p>                 return lines;<o:p></o:p>             }<o:p></o:p>             catch (Exception ex)<o:p></o:p>             {<o:p></o:p>                 //ErrorTool.ProcessError(ex);<o:p></o:p>                 //return;<o:p></o:p>                 throw (ex);<o:p></o:p>             }<o:p></o:p>         }<o:p> </o:p>         /// <summary><o:p></o:p>         /// Grabs a List of string lines from filepath indicated<o:p></o:p>         /// </summary><o:p></o:p>         /// <param name="path"><o:p></o:p>         /// string value of filepath to get lines from<o:p></o:p>         /// </param><o:p></o:p>         /// <returns><o:p></o:p>         /// List object containing each string line in the file<o:p></o:p>         /// </returns><o:p></o:p>         public static List<string> GetListOfLinesFromFile(string path)<o:p></o:p>         {<o:p></o:p>             try<o:p></o:p>             {<o:p></o:p>                 List<string> lines = new List<string>();<o:p></o:p>                 StreamReader reader = new StreamReader(path);<o:p> </o:p>                 string currentLine = string.Empty;<o:p> </o:p>                 while ((currentLine = reader.ReadLine()) != null)<o:p></o:p>                 {<o:p></o:p>                     lines.Add(currentLine);<o:p></o:p>                 }<o:p></o:p>                 reader.Close();<o:p></o:p>