Windows系统中C#读写ini配置文件的程序代码示例分享

时间:2021-10-19 08:01:55

   最近接触到INI配置文件的读写,虽然很久以前微软就推荐使用注册表来代替INI配置文件,现在在Visual Studio上也有专门的.Net配置文件格式,但是看来看去还是INI配置文件顺眼。事实上.Net的XML格式配置文件在功能上更加强大,我也更推荐大家使用这种类型的配置文件来进行.Net软件的开发,我之所以使用INI配置文件,无非是想尝一下鲜和个人习惯而已。

    C#本身没有提供访问INI配置文件的方法,但是我们可以使用WinAPI提供的方法来处理INI文件的读写,代码很简单!网上有大量现成的代码,这里只是作为记录和整理,方便日后使用。

INI配置文件的组成?

    INI文件是文本文件,由若干节(section)组成,在每个带中括号的节名称下,是若干个关键词(key)及其对应的值(Value),这些关键词(key)属于位于关键词(key)上的节(section)。

?
1
2
3
[Section]
Key1=Value1
Key2=Value2

 
Windows系统自带的Win32的API函数GetPrivateProfileString()和WritePrivateProfileString()分别实现了对INI文件的读写操作
所以可以写一个简单的类来读写ini文件,以满足一般应用的配置存取需求:

示例

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
class IniFile
  {
    /*
    * 声明API函数
    */
    public string iniPath;
    [DllImport("kernel32")]
    private static extern long WritePrivateProfileString(string section, string key, string val, string filePath);
    [DllImport("kernel32")]
    private static extern int GetPrivateProfileString(string section, string key, string def, StringBuilder retVal, int size, string filePath);
 
    /// <summary>
    /// 构造函数
    /// </summary>
    /// <param name="iniPath">ini文件路径,默认为当前路径下default.ini</param>
    public IniFile(string iniPath = "./default.ini")
    {
      this.iniPath = iniPath;
    }
 
    /// <summary>
    /// 写入ini文件
    /// </summary>
    /// <param name="Section">Section</param>
    /// <param name="Key">键</param>
    /// <param name="Value">值</param>
    public void writeIni(string Section, string Key, string Value)
    {
      WritePrivateProfileString(Section, Key, Value, this.iniPath);
    }
 
    /// <summary>
    /// 写入ini文件,不管section,默认放在default里
    /// </summary>
    /// <param name="Key">键</param>
    /// <param name="Value">值</param>
    public void writeIni(string Key, string Value)
    {
      WritePrivateProfileString("default", Key, Value, this.iniPath);
    }
 
    /// <summary>
    /// 读取ini文件
    /// </summary>
    /// <param name="Section">Section</param>
    /// <param name="Key">键</param>
    /// <returns>返回的值</returns>
    public string readIni(string Section, string Key)
    {
      StringBuilder temp = new StringBuilder(256);
      int i = GetPrivateProfileString(Section, Key, "", temp, 256, this.iniPath);
      return temp.ToString();
    }
 
    /// <summary>
    /// 读取section,不管section,默认从default里读取
    /// </summary>
    /// <param name="Key">键</param>
    /// <returns>返回值</returns>
    public string readIni(string Key)
    {
      return readIni("default", Key);
    }
 
    /// <summary>
    /// 查询ini文件是否存在
    /// </summary>
    /// <returns>是否存在</returns>
    public bool existINIFile()
    {
      return File.Exists(iniPath);
    }
  }

调用方式:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
class Program
{
  static void Main(string[] args)
  {
    IniFile iniFile = new IniFile("./hello.ini");
    iniFile.writeIni("section1", "key1", "value11");
    iniFile.writeIni("section1", "key2", "value12");
    iniFile.writeIni("section2", "key1", "value21");
    iniFile.writeIni("section2", "key2", "value22");
 
    iniFile.writeIni("key", "value");
 
    string str = iniFile.readIni("key");
    Console.WriteLine(str);
    Console.ReadKey();
  }
}