C#操作INI配置文件示例详解

下面是详细的“C#操作INI配置文件示例详解”攻略。

什么是INI文件？

INI文件是一种简单的文本文件，它通常用于存储程序的配置信息。INI文件由若干个节组成，每个节中包含若干个键值对，键值对用等号连接，例如：

[Database]
Server=127.0.0.1
Port=3306
Username=root
Password=123456

C#如何操作INI文件？

C#中操作INI文件需要使用Win32的API函数来实现，这些函数定义在kernel32.dll中。具体使用方法如下：

1. 引入DLL

首先需要引入kernel32.dll这个DLL文件，可以通过以下代码实现：

[DllImport("kernel32.dll")]
private static extern int GetPrivateProfileString(string lpAppName, string lpKeyName, string lpDefault, StringBuilder lpReturnedString, int nSize, string lpFileName);

[DllImport("kernel32.dll")]
private static extern bool WritePrivateProfileString(string lpAppName, string lpKeyName, string lpString, string lpFileName);

2. 读取INI文件

读取INI文件需要使用GetPrivateProfileString函数，该函数中有五个参数：

• lpAppName：节的名字，如果为NULL，则表示默认节。
• lpKeyName：键的名字。
• lpDefault：键不存在时的默认值。
• lpReturnedString：返回值的缓冲区。
• nSize：缓冲区大小。

以下是读取INI文件的示例代码：

string filePath = "config.ini";
string sectionName = "Database";
string keyName = "Server";
string defaultValue = "localhost";
StringBuilder buffer = new StringBuilder(256);
int bufferSize = 256;

int result = GetPrivateProfileString(sectionName, keyName, defaultValue, buffer, bufferSize, filePath);

string value = buffer.ToString();
Console.WriteLine("读取到的值为：" + value);

在这个示例中，我们读取了名为config.ini的INI文件中Database节中的Server键的值，如果键不存在，则返回默认值localhost。

3. 写入INI文件

写入INI文件需要使用WritePrivateProfileString函数，该函数中有四个参数：

• lpAppName：节的名字，如果为NULL，则表示默认节。
• lpKeyName：键的名字。
• lpString：要写入的值。
• lpFileName：INI文件的路径。

以下是写入INI文件的示例代码：

string filePath = "config.ini";
string sectionName = "Database";
string keyName = "Server";
string value = "127.0.0.1";

bool result = WritePrivateProfileString(sectionName, keyName, value, filePath);

if(result)
{
    Console.WriteLine("写入成功！");
}
else
{
    Console.WriteLine("写入失败！");
}

在这个示例中，我们将名为config.ini的INI文件中Database节中的Server键的值修改为127.0.0.1。

示例说明

示例1：读取数据库配置信息

假设我们有一个Windows窗体应用程序，需要读取数据库的配置信息。我们可以将数据库的地址、端口、用户名和密码放在一个名为config.ini的INI文件中，如下所示：

[Database]
Server=127.0.0.1
Port=3306
Username=root
Password=123456

然后在应用程序中，使用以上提到的读取INI文件的方法来读取config.ini文件中的配置信息，如下所示：

string filePath = "config.ini";
string sectionName = "Database";
string serverKeyName = "Server";
string portKeyName = "Port";
string usernameKeyName = "Username";
string passwordKeyName = "Password";
string defaultValue = "";
StringBuilder buffer = new StringBuilder(256);
int bufferSize = 256;

string server = ReadIniValue(filePath, sectionName, serverKeyName, defaultValue, buffer, bufferSize);
string port = ReadIniValue(filePath, sectionName, portKeyName, defaultValue, buffer, bufferSize);
string username = ReadIniValue(filePath, sectionName, usernameKeyName, defaultValue, buffer, bufferSize);
string password = ReadIniValue(filePath, sectionName, passwordKeyName, defaultValue, buffer, bufferSize);

// 使用读取到的配置信息来连接数据库

示例2：保存窗体的位置和大小

假设我们有一个Windows窗体应用程序，用户可以自由地调整窗体的位置和大小。我们希望在下一次打开应用程序时，能够加载用户上一次关闭应用程序前的窗体位置和大小。我们可以将窗体的位置和大小信息保存在一个名为settings.ini的INI文件中，如下所示：

[Form]
Left=200
Top=200
Width=800
Height=600

然后在应用程序中，使用以上提到的写入INI文件的方法来保存settings.ini文件中的信息，如下所示：

string filePath = "settings.ini";
string sectionName = "Form";
string leftKeyName = "Left";
string topKeyName = "Top";
string widthKeyName = "Width";
string heightKeyName = "Height";
string leftValue = this.Left.ToString();
string topValue = this.Top.ToString();
string widthValue = this.Width.ToString();
string heightValue = this.Height.ToString();

WriteIniValue(filePath, sectionName, leftKeyName, leftValue);
WriteIniValue(filePath, sectionName, topKeyName, topValue);
WriteIniValue(filePath, sectionName, widthKeyName, widthValue);
WriteIniValue(filePath, sectionName, heightKeyName, heightValue);

在下一次打开应用程序时，我们可以使用以上提到的读取INI文件的方法来读取settings.ini文件中的信息，并将窗体的位置和大小修改为读取到的值，如下所示：

string filePath = "settings.ini";
string sectionName = "Form";
string leftKeyName = "Left";
string topKeyName = "Top";
string widthKeyName = "Width";
string heightKeyName = "Height";
string defaultValue = "0";
StringBuilder buffer = new StringBuilder(256);
int bufferSize = 256;

int left = int.Parse(ReadIniValue(filePath, sectionName, leftKeyName, defaultValue, buffer, bufferSize));
int top = int.Parse(ReadIniValue(filePath, sectionName, topKeyName, defaultValue, buffer, bufferSize));
int width = int.Parse(ReadIniValue(filePath, sectionName, widthKeyName, defaultValue, buffer, bufferSize));
int height = int.Parse(ReadIniValue(filePath, sectionName, heightKeyName, defaultValue, buffer, bufferSize));

this.Left = left;
this.Top = top;
this.Width = width;
this.Height = height;

这样，在下一次打开应用程序时，窗体就会自动恢复到上一次关闭时的位置和大小了。