森先生 发表于 2023-9-25 00:05:01

C# 操作INI文件

C#读写INI文件

.NET程序中,可以作为配置文件使用的格式又很多,INI文件在某些场景应用较为广泛,如串口参数、一些工作站本地参数等等,INI文件主要用途为读取指定节点的配置内容,以及修改指定节点。一下文章主要描述在程序对INI文件的操作。
INI文件介绍

INI文件


[*]ini文件本质上就是一个扩展名为ini的文本文档,也可以当成记事本来操作。
[*]与文本文档的区别在于,ini文件有自己的格式。
INI文件结构


[*]INI文件由段落(section)、键(key)、值(value)组成
[*]section为段落名称,也可以理解为一个分组的标题。中括号表示。例如:
[*]键和值以key=nalue的形式表示,每个段落可以有多个键值对;
INI文件格式示例


key1=value1
key2=value2
key3=value3

key1=value1
key2=value2
key3=value3
... ... ... ...

k1=127.0.0.1
k2=127.0.0.2
k3=127.0.0.3
;IP列表每行开头添加 ; 为注释
在C#中操作INI文件

在C#命名空间中没有专门操作INI文件的类,但在kernel32.dll中,有Win32的API函数对文件的操作

[*]WritePrivateProfileString():写操作函数
[*]GetPrivateProfileString():读操作函数
写操作函数说明

函数声明

DllImport需引入命名空间 using System.Runtime.InteropServices;
      /// <summary>
      /// 修改INI文件内容
      /// </summary>
      /// <param name="lpApplicationName">节点名称(段落名称)section</param>
      /// <param name="lpKeyName">要设置的项名,Key</param>
      /// <param name="lpString">要写入的新字符串Value</param>
      /// <param name="lpFileName">INI文件晚挣路径</param>
      /// <returns>0表示失败,非零表示成功</returns>
      
      private static extern long WritePrivateProfileString
            (string lpApplicationName,
            string lpKeyName,
            string lpString,
            string lpFileName);调用

      /// <summary>
      /// 保存ini
      /// </summary>
      /// <param name="section">节点/段落名称</param>
      /// <param name="key">项/Key名称</param>
      /// <param name="value">值</param>
      /// <param name="filePath">ini文件路径</param>
      public static void WriteIniKeys(string section, string key, string value, string filePath)
      {
            WritePrivateProfileString(section, key, value, filePath);
      }

      /*
         * 若value为null则会删除配置文件中对应的key
         * 若key value为null则会删除对应的section
      */读操作函数说明

函数声明

DllImport需引入命名空间 using System.Runtime.InteropServices;
      /// <summary>
      /// 获取INI中指定字符串
      /// </summary>
      /// <param name="lpAppName">节点名称(段落名称)section</param>
      /// <param name="lpKeyName">项名,Key</param>
      /// <param name="lpDefault">未找到指定项时返回的默认值</param>
      /// <param name="lpReturnedString">指定一个字符串缓冲区,长度至少为nSize</param>
      /// <param name="nSize">指定装载到lpReturnedString缓冲区的最大字符数量</param>
      /// <param name="lpFileName">INI文件路径</param>
      /// <returns>复制到lpReturnedString中的字节数量</returns>
      
      private static extern int GetPrivateProfileString
            (string lpAppName,
            string lpKeyName,
            string lpDefault,
            StringBuilder lpReturnedString,
            int nSize,
            string lpFileName); 调用

      /// <summary>
      /// 根据section,key取值,并设置默认值
      /// </summary>
      /// <param name="section">节点/段落名称</param>
      /// <param name="key">项/Key名称</param>
      /// <param name="def">默认值</param>
      /// <param name="filePath">文件路径</param>
      /// <returns>返回指定内容,若不存在则返回默认值def</returns>
      private static string ReadIniKeys(string section, string key, string def, string filePath)
      {
            StringBuilder temp = new StringBuilder(1024);
            GetPrivateProfileString(section, key, def, temp, 1024, filePath);
            return temp.ToString();
      }以上为C#读写INI的实现方法,针对此方法编写了帮助类,项目已上传至Gitee
地址 :https://gitee.com/yang-yong-666/csharp
类文件:YYIniHelper.INIHelper.cs
个人交流QQ:1695690324
原创不易,转载请注明出处
博客园:https://www.cnblogs.com/yangyongdashen-S/
CSDN:https://blog.csdn.net/weixin_44312699?spm=1010.2135.3001.5343
Gitee:https://gitee.com/yang-yong-666
公众号:yi人夕岸

来源:https://www.cnblogs.com/yangyongdashen-S/archive/2023/09/24/YiRenXiAn_CSharp_INI.html
免责声明:由于采集信息均来自互联网,如果侵犯了您的权益,请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容,谢谢合作!
页: [1]
查看完整版本: C# 操作INI文件