讀寫INI輔助類

  1 using System.Text;
  2 using System.Runtime.InteropServices;
  3 using System;
  4  
  5 namespace Benson.INI讀寫
  6 {
  7     #region INI結構介紹
  8     /**
  9 INI文件實際上是一種具備特定結構的文本文件，它的構成分爲三部分，結構以下：
 10 [Section1]
 11 key 1 = value2
 12 key 1 = value2
 13 ……
 14 [Section2]
 15 key 1 = value1
 16 key 2 = value2
 17 ……
 18  
 19 文件由若干個段落（section）組成，每一個段落又分紅若干個鍵（key）和值（value）。
 20 */
 21     #endregion
 22  
 23     #region INI讀寫輔助類，採用WIN32API
 24     #region WIN32API介紹
 25     /*
 26 Windows系統自帶的Win32的API函數GetPrivateProfileString()和WritePrivateProfileString()分別實現了對INI文件的讀寫操做，他們位於kernel32.dll下。
 27 可是使人遺憾的是C#所使用的.NET框架下的公共類庫並無提供直接操做INI文件的類，因此惟一比較理想的方法就是調用API函數。
 28 而後，.Net框架下的類庫是基於託管代碼的，而API函數是基於非託管代碼的，（在運行庫的控制下執行的代碼稱做託管代碼。相反，在運行庫以外運行的代碼稱做非託管代碼。）如何實現託管代碼與非託管代碼之間的操做呢？.Net框架的System.Runtime.InteropServices命名空間下提供各類各樣支持COM interop及平臺調用服務的成員，其中最重要的屬性之一DllImportAttribute能夠用來定義用於訪問非託管API的平臺調用方法，它提供了對從非託管DLL導出的函數進行調用所必需的信息。下面就來看一下如何實現C#與API函數的互操做。 
 29 讀操做：
 30 [DllImport("kernel32")]
 31 private static extern int GetPrivateProfileString(string section, string key, string defVal, StringBuilder retVal, int size, string filePath); 
 32 section：要讀取的段落名
 33 key: 要讀取的鍵
 34 defVal: 讀取異常的狀況下的缺省值
 35 retVal: key所對應的值，若是該key不存在則返回空值
 36 size: 值容許的大小
 37 filePath: INI文件的完整路徑和文件名寫操做：
 38  
 39 寫操做
 40 [DllImport("kernel32")] 
 41 private static extern long WritePrivateProfileString(string section, string key, string val, string filePath); 
 42 section: 要寫入的段落名
 43 key: 要寫入的鍵，若是該key存在則覆蓋寫入
 44 val: key所對應的值
 45 filePath: INI文件的完整路徑和文件名
 46 */
 47     #endregion
 48  
 49     public class INIManager
 50     {
 51         public string iniPath; //INI文件路徑以及名稱
 52  
 53         #region DLL導入
 54         [DllImport("kernel32")]
 55         private static extern long WritePrivateProfileString(string section, string key, string val, string filePath);
 56         [DllImport("kernel32")]
 57         private static extern int GetPrivateProfileString(string section, string key, string def, StringBuilder retVal, int size, string filePath);
 58         #endregion
 59  
 60         #region 構造函數
 61         /// <summary> 
 62         /// 構造方法 
 63         /// </summary> 
 64         /// <param name="INIPath">文件路徑</param> 
 65         public INIManager(string INIPath)
 66         {
 67             iniPath = INIPath;
 68         }
 69  
 70         /// <summary>
 71         /// 在不提供文件時候的構造方法
 72         /// </summary>
 73         public INIManager() //若是不提供INI文件的路徑以及名稱，則默認爲當前的應用名稱.ini
 74         {
 75             char[] charsToTrim = { '\"',' '};
 76             string fileNameWithoutExtension = System.IO.Path.GetFileNameWithoutExtension(Environment.CommandLine.Trim(charsToTrim));
 77             iniPath = Environment.CurrentDirectory+ "\\" +fileNameWithoutExtension + ".ini";
 78             //Console.WriteLine(iniPath);  //Test Example
 79         }
 80         #endregion
 81  
 82         #region INI寫入
 83         /// <summary> 
 84         /// 寫入INI文件，若是鍵，值存在則直接覆蓋
 85         /// </summary> 
 86         /// <param name="section">段落名稱(如"SectionName"(無需雙引號）)</param> 
 87         /// <param name="key">鍵</param> 
 88         /// <param name="value">值</param> 
 89         public void IniWriteValue(string section, string key, string value)
 90         {
 91             WritePrivateProfileString(section, key, value, this.iniPath);
 92         }
 93  
 94         /// <summary>
 95         /// 寫入INI文件，默認Default段落
 96         /// </summary>
 97         /// <param name="Key">鍵</param>
 98         /// <param name="Value">值</param>
 99         public void IniWriteValue( string Key, string Value)
100         {
101             string Section = @"Default";
102             IniWriteValue(Section, Key, Value);
103         }
104         #endregion
105  
106         #region INI讀取
107         /// <summary> 
108         /// 讀出INI文件 
109         /// </summary> 
110         /// <param name="section">段落名稱(如"SectionName"(無需雙引號） )</param> 
111         /// <param name="Key">鍵</param> 
112         /// <returns>返回對應鍵的值</returns>
113         public string IniReadValue(string section, string Key)
114         {
115             StringBuilder temp = new StringBuilder(500);
116             int i = GetPrivateProfileString(section, Key, "", temp, 500, this.iniPath);
117             return temp.ToString();
118         }
119  
120         /// <summary>
121         /// 讀出INI文件,默認狀況下從Default中讀取
122         /// </summary>
123         /// <param name="Key">鍵</param>
124         /// <returns>返回對應鍵的值</returns>
125         public string IniReadValue(string Key) 
126         {
127             string section = @"Default";
128             return IniReadValue(section, Key);
129         }
130  
131     }
132         #endregion
133  
134     #endregion
135  
136     #region 測試用類
137     class Test 
138     {
139         static void Main(string[] args)
140         {
141             INIManager imDriveC = new INIManager(@"c:\test.ini");
142             Console.WriteLine(imDriveC.IniReadValue("name1").Equals("").ToString()); //首先查看在文件不存在的狀況下的是否有異常，異常讀取到的值
143             imDriveC.IniWriteValue("name1", "carl");
144             Console.WriteLine(imDriveC.IniReadValue("Name1"));
145  
146  
147  
148             INIManager im = new INIManager();
149             im.IniWriteValue("姓","Cai");
150             im.IniWriteValue("名", "Benson");
151             
152             Console.WriteLine(im.IniReadValue("姓"));
153             Console.WriteLine(im.IniReadValue("cao"));
154             Console.ReadKey();
155         }
156     }
157 #endregion
158  
159 }