C#操作INI文件的辅助类IniHelper

INI文件是一种格式简单的配置文件，在Windows中被广泛应用。C#可以通过调用Win API函数来操作INI文件，但是操作起来比较繁琐。因此，使用辅助类IniHelper可以更加方便、简单地操作INI文件。

使用IniHelper

IniHelper类封装了INI文件读、写等操作，使用前需要引入该类所在的命名空间：

using System;
using System.Collections.Generic;
using System.Text;
using System.Runtime.InteropServices;

IniHelper类的成员方法

1.读取INI文件

读取整个INI文件

Dictionary<string, Dictionary<string, string>> ReadAllIni(string INIPath);

参数：

• INIPath: INI文件的路径。

返回值：

• 一个Dictionary对象，其中每个键表示一个section，每个值也是一个Dictionary对象，其中每个键为一个key，每个值为该key所对应的value。

获取INI文件中指定key所在的值

string GetIniKeyValue(string section, string key, string INIPath, string defaultValue = "");

参数：

• section: 节点名称。
• key: 键名称。
• INIPath: INI文件的路径。
• defaultValue: 可选参数，默认返回空字符串。若无法获取对于键的值，则返回到该值。

返回值：

• 返回节点名称section中的键名称为key的值，如果找不到，返回默认值defaultValue。

2.写入INI文件

写入INI文件节点值

bool WriteIniSection(string section, Dictionary<string, string> kvp, string INIPath);

参数：

• section: 节点名称。
• kvp: 节点中需要写入的键值对（字典）。
• INIPath: INI文件的路径。

返回值：

• 返回值为真则表示写入成功，否则为失败。

写入INI文件键值

bool WriteIniKeyVaule(string section, string key, string value, string INIPath);

参数：

• section: 节点名称。
• key: 键名称。
• value: 键对应的值。
• INIPath: INI文件的路径。

返回值：

• 返回值为真则表示写入成功，否则为失败。

示例

以下是两个使用IniHelper的示例，分别是读取INI文件以及写入INI文件。

示例1：读取INI文件

假设有以下INI文件config.ini：

[Section1]
key1=value1
key2=value2

[Section2]
key3=value3
key4=value4

我们可以通过以下代码读取该INI文件：

string iniPath = @"C:\temp\config.ini";
Dictionary<string, Dictionary<string, string>> iniDict = IniHelper.ReadAllIni(iniPath);
foreach (var section in iniDict)
{
    Console.WriteLine($"Section: {section.Key}");
    foreach (var kv in section.Value)
    {
        Console.WriteLine($"Key: {kv.Key}, Value: {kv.Value}");
    }
}

运行上述代码后，输出如下：

Section: Section1
Key: key1, Value: value1
Key: key2, Value: value2
Section: Section2
Key: key3, Value: value3
Key: key4, Value: value4

示例2：写入INI文件

假设有以下INI文件config.ini：

[Section1]
key1=value1
key2=value2

[Section2]
key3=value3
key4=value4

我们可以通过以下代码在该INI文件中添加一个新的section及其对应的键值：

string iniPath = @"C:\temp\config.ini";
string section = "Section3";
Dictionary<string, string> kvp = new Dictionary<string, string>
{
    { "key5", "value5" },
    { "key6", "value6" },
};
IniHelper.WriteIniSection(section, kvp, iniPath);

运行上述代码后，config.ini文件内容变为：

[Section1]
key1=value1
key2=value2

[Section2]
key3=value3
key4=value4

[Section3]
key5=value5
key6=value6

总结

IniHelper类封装了INI文件读写操作，使用起来非常方便，使我们不必直接调用Win API函数即可完成对INI文件的操作。通过上述的示例，相信大家已经掌握了IniHelper的使用方法。