C# 操作ini文件

INI文件是一种按照特点方式排列的文本文件。每一个INI文件构成都非常类似，由若干段落（section）组成，在每个带括号的标题下面，是若干个以单个单词开头的关键词（keyword）和一个等号，等

号右边的就是关键字对应的值（value）。其一般形式如下：

[section1]
 keyword1=value1 
 keyword2=value2
 keyword3=value3
[section2]
 keyword1=value1
 keyword2=value2

class Program

    {

        [DllImport("kernel32")]

        private  static extern long WritePrivateProfileString (string section ,string key , string val ,string filepath);

        //参数说明：section：INI文件中的段落；key：INI文件中的关键字；val：INI文件中关键字的数值；filePath：INI文件的完整的路径和名称。

        [DllImport ("kernel32")]

        private static extern int GetPrivateProfileString (string section , string key , string def , StringBuilder retVal , int size , string filePath ) ;

        //参数说明：section：INI文件中的段落名称；key：INI文件中的关键字；def：无法读取时候时候的缺省数值；retVal：读取数值；size：数值的大小；filePath：INI文件的完整路径和名称。

        public static void Main(string[] args)

        {

            

            string section="database";

            string key="sql";

            //string value="server.;database=pubs;uid=sa;pwd=";

            string fileName="d:\config.ini";

            

            try

            {

                //写入ini节点

                //WritePrivateProfileString(section,key,value,fileName);

                

                //读取ini节点

                StringBuilder sb=new StringBuilder(255);

                GetPrivateProfileString(section,key,"无法读取",sb,255,fileName);

                

                Console.WriteLine(sb.ToString());

                

            }catch(Exception ex)

            {

                Console.WriteLine(ex.ToString());

            }

            

            Console.Write("Press any key to continue . . . ");

            Console.ReadKey(true);

        }

        

    }

整理出ini文件操作类:

/// <summary>
    /// 读写INI文件的类。
    /// </summary>
    public class INIHelper
    {
        // 读写INI文件相关。
        [DllImport("kernel32.dll", EntryPoint = "WritePrivateProfileString", CharSet = CharSet.Ansi)]
        public static extern long WritePrivateProfileString(string section, string key, string val, string filePath);
        [DllImport("kernel32.dll", EntryPoint = "GetPrivateProfileString", CharSet = CharSet.Ansi)]
        public static extern int GetPrivateProfileString(string section, string key, string def, StringBuilder retVal, int size, string filePath);

        [DllImport("kernel32.dll", EntryPoint = "GetPrivateProfileSectionNames", CharSet = CharSet.Ansi)]
        public static extern int GetPrivateProfileSectionNames(IntPtr lpszReturnBuffer, int nSize, string filePath);
        
        [DllImport("KERNEL32.DLL ", EntryPoint = "GetPrivateProfileSection", CharSet = CharSet.Ansi)]
        public static extern int GetPrivateProfileSection(string lpAppName, byte[] lpReturnedString, int nSize, string filePath);


        /// <summary>
        /// 向INI写入数据。
        /// </summary>
        /// <PARAM name="Section">节点名。</PARAM>
        /// <PARAM name="Key">键名。</PARAM>
        /// <PARAM name="Value">值名。</PARAM>
        public static void Write(string Section, string Key, string Value, string path)
        {
            WritePrivateProfileString(Section, Key, Value, path);
        }


        /// <summary>
        /// 读取INI数据。
        /// </summary>
        /// <PARAM name="Section">节点名。</PARAM>
        /// <PARAM name="Key">键名。</PARAM>
        /// <PARAM name="Path">值名。</PARAM>
        /// <returns>相应的值。</returns>
        public static string Read(string Section, string Key, string path)
        {
            StringBuilder temp = new StringBuilder(255);
            int i = GetPrivateProfileString(Section, Key, "", temp, 255, path);
            return temp.ToString();
        }

        /// <summary>
        /// 读取一个ini里面所有的节
        /// </summary>
        /// <param name="sections"></param>
        /// <param name="path"></param>
        /// <returns></returns>
        public static int GetAllSectionNames(out string[] sections, string path)
        {
            int MAX_BUFFER = 32767;
            IntPtr pReturnedString = Marshal.AllocCoTaskMem(MAX_BUFFER);
            int bytesReturned = GetPrivateProfileSectionNames(pReturnedString, MAX_BUFFER, path);
            if (bytesReturned == 0)
            {
                sections = null;
                return -1;
            }
            string local = Marshal.PtrToStringAnsi(pReturnedString, (int)bytesReturned).ToString();
            Marshal.FreeCoTaskMem(pReturnedString);
            //use of Substring below removes terminating null for split
            sections = local.Substring(0, local.Length - 1).Split('');
            return 0;
        }

        /// <summary>
        /// 得到某个节点下面所有的key和value组合
        /// </summary>
        /// <param name="section"></param>
        /// <param name="keys"></param>
        /// <param name="values"></param>
        /// <param name="path"></param>
        /// <returns></returns>
        public static int GetAllKeyValues(string section, out string[] keys, out string[] values, string path)
        {
            byte[] b = new byte[65535];

            GetPrivateProfileSection(section, b, b.Length, path);
            string s = System.Text.Encoding.Default.GetString(b);
            string[] tmp = s.Split((char)0);
            ArrayList result = new ArrayList();
            foreach (string r in tmp)
            {
                if (r != string.Empty)
                    result.Add(r);
            }
            keys = new string[result.Count];
            values = new string[result.Count];
            for (int i = 0; i < result.Count; i++)
            {
                string[] item = result[i].ToString().Split(new char[] { '=' });
                if (item.Length == 2)
                {
                    keys[i] = item[0].Trim();
                    values[i] = item[1].Trim();
                }
                else if (item.Length == 1)
                {
                    keys[i] = item[0].Trim();
                    values[i] = "";
                }
                else if (item.Length == 0)
                {
                    keys[i] = "";
                    values[i] = "";
                }
            }

            return 0;
        }

    }

文件由若干个段落（section）组成，每个段落又分成若干个键（key）和值（value）。Windows系统自带的Win32的API函数GetPrivateProfileString()和WritePrivateProfileString()分别实现了对INI文件的读写操作，他们位于kernel32.dll下。

但是令人遗憾的是C#所使用的.NET框架下的公共类库并没有提供直接操作INI文件的类，所以唯一比较理想的方法就是调用API函数。

然后，.Net框架下的类库是基于托管代码的，而API函数是基于非托管代码的，（在运行库的控制下执行的代码称作托管代码。相反，在运行库之外运行的代码称作非托管代码。）如何实现托管代码与非托管代码之间的操作呢？.Net框架的System.Runtime.InteropServices命名空间下提供各种各样支持COM interop及平台调用服务的成员，其中最重要的属性之一DllImportAttribute可以用来定义用于访问非托管API的平台调用方法，它提供了对从非托管DLL导出的函数进行调用所必需的信息。下面就来看一下如何实现C#与API函数的互操作。

读操作：

[DllImport("kernel32")]
private static extern int GetPrivateProfileString(string section, string key, string defVal, StringBuilder retVal, int size, string filePath); 
section：要读取的段落名
key: 要读取的键
defVal: 读取异常的情况下的缺省值
retVal: key所对应的值，如果该key不存在则返回空值
size: 值允许的大小
filePath: INI文件的完整路径和文件名

写操作：

[DllImport("kernel32")] 
private static extern long WritePrivateProfileString(string section, string key, string val, string filePath); 
section: 要写入的段落名
key: 要写入的键，如果该key存在则覆盖写入
val: key所对应的值
filePath: INI文件的完整路径和文件名

这样，在就可以使用对他们的调用，用常规的方式定义一个名为IniFile类：

1using System;
 2using System.Runtime.InteropServices; 
 3using System.Text; 
 4
 5namespace IPVOD.Hotel.Remoting
 6{
 7    /// <summary>
 8    /// INI文件的操作类
 9    /// </summary>
10    public class IniFile
11    {
12        public string Path;
13
14        public IniFile(string path)
15        {
16            this.Path = path;
17        }
18        
19        #region 声明读写INI文件的API函数 
20        [DllImport("kernel32")] 
21        private static extern long WritePrivateProfileString(string section, string key, string val, string filePath); 
22
23        [DllImport("kernel32")]
24        private static extern int GetPrivateProfileString(string section, string key, string defVal, StringBuilder retVal, int size, string filePath); 
25
26        [DllImport("kernel32")]
27        private static extern int GetPrivateProfileString(string section, string key, string defVal, Byte[] retVal, int size, string filePath);
28        #endregion
29
30        /// <summary>
31        /// 写INI文件
32        /// </summary>
33        /// <param name="section">段落</param>
34        /// <param name="key">键</param>
35        /// <param name="iValue">值</param>
36        public void IniWriteValue(string section, string key, string iValue) 
37        {
38            WritePrivateProfileString(section, key, iValue, this.Path);
39        }
40
41        /// <summary>
42        /// 读取INI文件
43        /// </summary>
44        /// <param name="section">段落</param>
45        /// <param name="key">键</param>
46        /// <returns>返回的键值</returns>
47        public string IniReadValue(string section, string key) 
48        { 
49            StringBuilder temp = new StringBuilder(255); 
50
51            int i = GetPrivateProfileString(section, key, "", temp, 255, this.Path); 
52            return temp.ToString();
53        }
54
55        /// <summary>
56        /// 读取INI文件
57        /// </summary>
58        /// <param name="Section">段，格式[]</param>
59        /// <param name="Key">键</param>
60        /// <returns>返回byte类型的section组或键值组</returns>
61        public byte[] IniReadValues(string section, string key)
62        {
63            byte[] temp = new byte[255];
64
65            int i = GetPrivateProfileString(section, key, "", temp, 255, this.Path);
66            return temp;
67        }
68    }
69}
70

注意：我增加了DLL导出的函数GetPrivateProfileString的重载，说明如下：

[DllImport("kernel32")] 
private static extern int GetPrivateProfileString(string section, string key, string defVal, Byte[] retVal, int size, string filePath);
section：要读取的段落名
key: 要读取的键
defVal: 读取异常的情况下的缺省值
retVal: 此参数类型不是string，而是Byte[]用于返回byte类型的section组或键值组。
size: 值允许的大小
filePath: INI文件的完整路径和文件名

下面看一下具体实例化IniFile类的操作：

//path为ini文件的物理路径

IniFile ini = new IniFile(path);

//读取ini文件的所有段落名

byte[] allSection = ini.IniReadValues(null, null);

 

通过如下方式转换byte[]类型为string[]数组类型

string[] sectionList;

ASCIIEncoding ascii = new ASCIIEncoding();

//获取自定义设置section中的所有key，byte[]类型

sectionByte = ini.IniReadValues("personal", null);

//编码所有key的string类型

sections = ascii.GetString(sectionByte);

//获取key的数组

sectionList = sections.Split(new char[1]{''});

 

//读取ini文件personal段落的所有键名，返回byte[]类型

byte[] sectionByte = ini.IniReadValues("personal", null);

 

//读取ini文件evideo段落的MODEL键值

model = ini.IniReadValue("evideo", "MODEL");

 

//将值eth0写入ini文件evideo段落的DEVICE键

ini.IniWriteValue("evideo", "DEVICE", "eth0");

即：

[evideo]

DEVICE = eth0

 

//删除ini文件下personal段落下的所有键

ini.IniWriteValue("personal", null, null);

 

//删除ini文件下所有段落

ini.IniWriteValue(null, null, null);

创建Ini参考：http://blog.csdn.net/sdfkfkd/article/details/7050733