C# INI文件读写方法_c#ini文件如何一次读取所有数据

在C#项目的开发实践里，存在着一种十分常见且实用的操作习惯，那就是把一部分常用的参数值写入到 .ini文件当中。这种做法背后有着充分的考量。从软件系统的设计角度来看，将常用参数集中存放在 .ini文件里，能够极大地提升程序的可维护性和灵活性。在一个复杂的C#项目中，可能会涉及到众多不同类型的参数，这些参数在程序运行过程中起到了关键的配置作用。如果将它们硬编码在程序代码里，一旦需要对某个参数进行调整，就不得不去修改代码，重新编译和部署程序，这无疑会增加开发和维护的成本。而使用 .ini文件来存储这些参数，只需要修改文件中的对应值，程序就能在下次启动时使用新的参数，避免了频繁修改代码带来的风险。

当程序启动并开始运行的时候，它会首先执行一个重要的操作，即读取上一次写入到 .ini文件中的数值。这一过程对于程序的正常运行至关重要。想象一下，在一个工业自动化控制系统的C#项目中，各种设备的运行参数可能会根据不同的生产任务进行调整。每次设备启动时，如果不能准确读取上一次的参数设置，就可能导致设备运行状态异常，甚至引发生产事故。通过读取 .ini文件中的参数，程序可以恢复到上一次的运行配置，确保系统的稳定性和连续性。

为了更清晰地阐述如何在C#项目中实现对 .ini文件的操作，本文将以PLC（可编程逻辑控制器）通信参数的设置和读取为例进行详细说明。PLC在工业自动化领域有着广泛的应用，它与上位机之间的通信需要准确的参数配置，如通信端口、波特率、数据位等。这些参数的设置直接影响到通信的稳定性和准确性。在C#项目中，我们可以通过创建一个名为INIOperationClass的类来实现对 .ini文件中对应内容的读取和写入操作。这个类将封装一系列的方法，用于打开 .ini文件、读取指定参数的值、写入新的参数值等。

下面我们来详细分析INIOperationClass类的具体实现。首先，我们需要定义类的成员变量和构造函数。成员变量可以包括 .ini文件的路径、缓存字典等。构造函数将负责初始化这些成员变量，并在必要时创建 .ini文件。在读取PLC通信参数时，我们可以通过传入参数名称，调用类中的读取方法，该方法将首先检查缓存中是否存在该参数的值，如果不存在则打开 .ini文件，查找对应的参数项并读取其值，同时将该值存入缓存中。在写入PLC通信参数时，我们可以传入参数名称和新的参数值，调用类中的写入方法，该方法将更新 .ini文件中对应参数的值，并清空缓存中该参数的旧值，以确保下次读取时能获取到最新的值。

通过以上的详细阐述，我们可以看到在C#项目中使用 .ini文件存储常用参数并通过INIOperationClass类实现读写操作是一种非常实用的开发技巧。它不仅能提高程序的可维护性和灵活性，还能确保程序在不同的运行环境下都能稳定、高效地运行。

1. 编写类INIOperationClass

public class INIOperationClass

{

#region INI文件操作

/*

* 针对INI文件的API操作方法，其中的节点（Section)、键（KEY）都不区分大小写

* 如果指定的INI文件不存在，会自动创建该文件。

*

* CharSet定义的时候使用了什么类型，在使用相关方法时必须要使用相应的类型

* 例如 GetPrivateProfileSectionNames声明为CharSet.Auto,那么就应该使用 Marshal.PtrToStringAuto来读取相关内容

* 如果使用的是CharSet.Ansi，就应该使用Marshal.PtrToStringAnsi来读取内容

*

*/

#region API声明

/// <summary>

/// 获取所有节点名称(Section)

/// </summary>

/// <param name="lpszReturnBuffer">存放节点名称的内存地址,每个节点之间用\0分隔</param>

/// <param name="nSize">内存大小(characters)</param>

/// <param name="lpFileName">Ini文件</param>

/// <returns>内容的实际长度,为0表示没有内容,为nSize-2表示内存大小不够</returns>

[DllImport("kernel32.dll", CharSet = CharSet.Auto)]

Private static extern uint GetPrivateProfileSectionNames(IntPtr lpszReturnBuffer, uint nSize, string lpFileName);

/// <summary>

/// 获取某个指定节点(Section)中所有KEY和Value

/// </summary>

/// <param name="lpAppName">节点名称</param>

/// <param name="lpReturnedString">返回值的内存地址,每个之间用\0分隔</param>

/// <param name="nSize">内存大小(characters)</param>

/// <param name="lpFileName">Ini文件</param>

/// <returns>内容的实际长度,为0表示没有内容,为nSize-2表示内存大小不够</returns>

[DllImport("kernel32.dll", CharSet = CharSet.Auto)]

private static extern uint GetPrivateProfileSection(string lpAppName, IntPtr lpReturnedString, uint nSize, string lpFileName);

/// <summary>

/// 读取INI文件中指定的Key的值

/// </summary>

/// <param name="lpAppName">节点名称。如果为null,则读取INI中所有节点名称,每个节点名称之间用\0分隔</param>

/// <param name="lpKeyName">Key名称。如果为null,则读取INI中指定节点中的所有KEY,每个KEY之间用\0分隔</param>

/// <param name="lpDefault">读取失败时的默认值</param>

/// <param name="lpReturnedString">读取的内容缓冲区，读取之后，多余的地方使用\0填充</param>

/// <param name="nSize">内容缓冲区的长度</param>

/// <param name="lpFileName">INI文件名</param>

/// <returns>实际读取到的长度</returns>

[DllImport("kernel32.dll", CharSet = CharSet.Auto)]

private static extern uint GetPrivateProfileString(string lpAppName, string lpKeyName, string lpDefault, [In, Out] char[] lpReturnedString, uint nSize, string lpFileName);

//另一种声明方式,使用 StringBuilder 作为缓冲区类型的缺点是不能接受\0字符，会将\0及其后的字符截断,

//所以对于lpAppName或lpKeyName为null的情况就不适用

[DllImport("kernel32.dll", CharSet = CharSet.Auto)]

Private static extern uint GetPrivateProfileString(string lpAppName, string lpKeyName, string lpDefault, StringBuilder lpReturnedString, uint nSize, string lpFileName);

//再一种声明，使用string作为缓冲区的类型同char[]

[DllImport("kernel32.dll", CharSet = CharSet.Auto)]

private static extern uint GetPrivateProfileString(string lpAppName, string lpKeyName, string lpDefault, string lpReturnedString, uint nSize, string lpFileName);

/// <summary>

/// 将指定的键值对写到指定的节点，如果已经存在则替换。

/// </summary>

/// <param name="lpAppName">节点，如果不存在此节点，则创建此节点</param>

/// <param name="lpString">Item键值对，多个用\0分隔,形如key1=value1\0key2=value2

/// <para>如果为string.Empty，则删除指定节点下的所有内容，保留节点</para>

/// <para>如果为null，则删除指定节点下的所有内容，并且删除该节点</para>

/// </param>

/// <param name="lpFileName">INI文件</param>

/// <returns>是否成功写入</returns>

[DllImport("kernel32.dll", CharSet = CharSet.Auto)]

[return: MarshalAs(UnmanagedType.Bool)] //可以没有此行

private static extern bool WritePrivateProfileSection(string lpAppName, string lpString, string lpFileName);

/// <summary>

/// 将指定的键和值写到指定的节点，如果已经存在则替换

/// </summary>

/// <param name="lpAppName">节点名称</param>

/// <param name="lpKeyName">键名称。如果为null，则删除指定的节点及其所有的项目</param>

/// <param name="lpString">值内容。如果为null，则删除指定节点中指定的键。</param>

/// <param name="lpFileName">INI文件</param>

/// <returns>操作是否成功</returns>

[DllImport("kernel32.dll", CharSet = CharSet.Auto, SetLastError = true)]

[return: MarshalAs(UnmanagedType.Bool)]

private static extern bool WritePrivateProfileString(string lpAppName, string lpKeyName, string lpString, string lpFileName);

#endregion

#region 封装

/// <summary>

/// 读取INI文件中指定INI文件中的所有节点名称(Section)

/// </summary>

/// <param name="iniFile">Ini文件</param>

/// <returns>所有节点,没有内容返回string[0]</returns>

public static string[] INIGetAllSectionNames(string iniFile)

{

uint MAX_BUFFER = 32767; //默认为32767

string[] sections = new string[0]; //返回值

//申请内存

IntPtr pReturnedString = Marshal.AllocCoTaskMem((int)MAX_BUFFER * sizeof(char));

uint bytesReturned = INIOperationClass.GetPrivateProfileSectionNames(pReturnedString, MAX_BUFFER, iniFile);

if (bytesReturned != 0)

{

//读取指定内存的内容

string local = Marshal.PtrToStringAuto(pReturnedString, (int)bytesReturned).ToString();

//每个节点之间用\0分隔,末尾有一个\0

sections = local.Split(new char[] { '\0' }, StringSplitOptions.RemoveEmptyEntries);

}

//释放内存

Marshal.FreeCoTaskMem(pReturnedString);

return sections;

}

/// <summary>

/// 获取INI文件中指定节点(Section)中的所有条目(key=value形式)

/// </summary>

/// <param name="iniFile">Ini文件</param>

/// <param name="section">节点名称</param>

/// <returns>指定节点中的所有项目,没有内容返回string[0]</returns>

public static string[] INIGetAllItems(string iniFile, string section)

{

//返回值形式为 key=value,例如 Color=Red

uint MAX_BUFFER = 32767; //默认为32767

string[] items = new string[0]; //返回值

//分配内存

IntPtr pReturnedString = Marshal.AllocCoTaskMem((int)MAX_BUFFER * sizeof(char));

uint bytesReturned = INIOperationClass.GetPrivateProfileSection(section, pReturnedString, MAX_BUFFER, iniFile);

if (!(bytesReturned == MAX_BUFFER - 2) || (bytesReturned == 0))

{

string returnedString = Marshal.PtrToStringAuto(pReturnedString, (int)bytesReturned);

items = returnedString.Split(new char[] { '\0' }, StringSplitOptions.RemoveEmptyEntries);

}

Marshal.FreeCoTaskMem(pReturnedString); //释放内存

return items;

}

/// <summary>

/// 获取INI文件中指定节点(Section)中的所有条目的Key列表

/// </summary>

/// <param name="iniFile">Ini文件</param>

/// <param name="section">节点名称</param>

/// <returns>如果没有内容,反回string[0]</returns>

public static string[] INIGetAllItemKeys(string iniFile, string section)

{

string[] value = new string[0];

const int SIZE = 1024 * 10;

if (string.IsNullOrEmpty(section))

{

throw new ArgumentException("必须指定节点名称", "section");

}

char[] chars = new char[SIZE];

uint bytesReturned = INIOperationClass.GetPrivateProfileString(section, null, null, chars, SIZE, iniFile);

if (bytesReturned != 0)

{

value = new string(chars).Split(new char[] { '\0' }, StringSplitOptions.RemoveEmptyEntries);

}

chars = null;

return value;

}

/// <summary>

/// 读取INI文件中指定KEY的字符串型值

/// </summary>

/// <param name="iniFile">Ini文件</param>

/// <param name="section">节点名称</param>

/// <param name="key">键名称</param>

/// <param name="defaultValue">如果没此KEY所使用的默认值</param>

/// <returns>读取到的值</returns>

public static string INIGetStringValue(string iniFile, string section, string key, string defaultValue)

{

string value = defaultValue;

const int SIZE = 1024 * 10;

if (string.IsNullOrEmpty(section))

{

throw new ArgumentException("必须指定节点名称", "section");

}

if (string.IsNullOrEmpty(key))

{

throw new ArgumentException("必须指定键名称(key)", "key");

}

StringBuilder sb = new StringBuilder(SIZE);

uint bytesReturned = INIOperationClass.GetPrivateProfileString(section, key, defaultValue, sb, SIZE, iniFile);

if (bytesReturned != 0)

{

value = sb.ToString();

}

sb = null;

return value;

}

/// <summary>

/// 在INI文件中，将指定的键值对写到指定的节点，如果已经存在则替换

/// </summary>

/// <param name="iniFile">INI文件</param>

/// <param name="section">节点，如果不存在此节点，则创建此节点</param>

/// <param name="items">键值对，多个用\0分隔,形如key1=value1\0key2=value2</param>

/// <returns></returns>

public static bool INIWriteItems(string iniFile, string section, string items)

{

if (string.IsNullOrEmpty(section))

{

throw new ArgumentException("必须指定节点名称", "section");

}

if (string.IsNullOrEmpty(items))

{

throw new ArgumentException("必须指定键值对", "items");

}

return INIOperationClass.WritePrivateProfileSection(section, items, iniFile);

}

/// <summary>

/// 在INI文件中，指定节点写入指定的键及值。如果已经存在，则替换。如果没有则创建。

/// </summary>

/// <param name="iniFile">INI文件</param>

/// <param name="section">节点</param>

/// <param name="key">键</param>

/// <param name="value">值</param>

/// <returns>操作是否成功</returns>

Public static bool INIWriteValue(string iniFile, string section, string key, string value)

{

if (string.IsNullOrEmpty(section))

{

throw new ArgumentException("必须指定节点名称", "section");

}

if (string.IsNullOrEmpty(key))

{

throw new ArgumentException("必须指定键名称", "key");

}

if (value == null)

{

throw new ArgumentException("值不能为null", "value");

}

return INIOperationClass.WritePrivateProfileString(section, key, value, iniFile);

}

/// <summary>

/// 在INI文件中，删除指定节点中的指定的键。

/// </summary>

/// <param name="iniFile">INI文件</param>

/// <param name="section">节点</param>

/// <param name="key">键</param>

/// <returns>操作是否成功</returns>

public static bool INIDeleteKey(string iniFile, string section, string key)

{

if (string.IsNullOrEmpty(section))

{

throw new ArgumentException("必须指定节点名称", "section");

}

if (string.IsNullOrEmpty(key))

{

throw new ArgumentException("必须指定键名称", "key");

}

return INIOperationClass.WritePrivateProfileString(section, key, null, iniFile);

}

/// <summary>

/// 在INI文件中，删除指定的节点。

/// </summary>

/// <param name="iniFile">INI文件</param>

/// <param name="section">节点</param>

/// <returns>操作是否成功</returns>

public static bool INIDeleteSection(string iniFile, string section)

{

if (string.IsNullOrEmpty(section))

{

throw new ArgumentException("必须指定节点名称", "section");

}

return INIOperationClass.WritePrivateProfileString(section, null, null, iniFile);

}

/// <summary>

/// 在INI文件中，删除指定节点中的所有内容。

/// </summary>

/// <param name="iniFile">INI文件</param>

/// <param name="section">节点</param>

/// <returns>操作是否成功</returns>

public static bool INIEmptySection(string iniFile, string section)

{

if (string.IsNullOrEmpty(section))

{

throw new ArgumentException("必须指定节点名称", "section");

}

return INIOperationClass.WritePrivateProfileSection(section, string.Empty, iniFile);

}

private void TestIniINIOperation()

{

string file = "F:\\TestIni.ini";

//写入/更新键值

INIWriteValue(file, "Desktop", "Color", "Red");

INIWriteValue(file, "Desktop", "Width", "3270");

INIWriteValue(file, "Toolbar", "Items", "Save,Delete,Open");

INIWriteValue(file, "Toolbar", "Dock", "True");

//写入一批键值

INIWriteItems(file, "Menu", "File=文件\0View=视图\0Edit=编辑");

//获取文件中所有的节点

string[] sections = INIGetAllSectionNames(file);

//获取指定节点中的所有项

string[] items = INIGetAllItems(file, "Menu");

//获取指定节点中所有的键

string[] keys = INIGetAllItemKeys(file, "Menu");

//获取指定KEY的值

string value = INIGetStringValue(file, "Desktop", "color", null);

//删除指定的KEY

INIDeleteKey(file, "desktop", "color");

//删除指定的节点

INIDeleteSection(file, "desktop");

//清空指定的节点

INIEmptySection(file, "toolbar");

}

#endregion

#endregion

}

1. 参数写入事例

实现功能： 向config.ini文件写入PLC通信参数（将IP地址、机架号、插槽号写入config.ini文件内）

INIOperationClass.INIWriteValue(Environment.CurrentDirectory + "\\config.ini", "PlcInfo", "Address", txtIp.Text);

INIOperationClass.INIWriteValue(Environment.CurrentDirectory + "\\config.ini", "PlcInfo", "Rack", txtRack.Text);

INIOperationClass.INIWriteValue(Environment.CurrentDirectory + "\\config.ini", "PlcInfo", "Slot", txtSolt.Text);

1. Ini文件内容读取

txtIp.Text = INIOperationClass.INIGetStringValue(Environment.CurrentDirectory + "\\config.ini", "PlcInfo", "Address", "");

txtRack.Text = INIOperationClass.INIGetStringValue(Environment.CurrentDirectory + "\\config.ini", "PlcInfo", "Rack", "");

txtSolt.Text = INIOperationClass.INIGetStringValue(Environment.CurrentDirectory + "\\config.ini", "PlcInfo", "Slot", "");

txtIp.SelectionLength = 0;

txtIp.SelectionStart = 0;

1. 程序运行结果

例如 “PLC通信参数设置”如下图所示：

文件打开如下图所示：