翼度科技»论坛 编程开发 .net 查看内容

C# 操作INI文件

5

主题

5

帖子

15

积分

新手上路

Rank: 1

积分
15
C#读写INI文件

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

INI文件


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


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

[section_A]
key1=value1
key2=value2
key3=value3
[section_B]
key1=value1
key2=value2
key3=value3
... ... ... ...
  1. [IPLIST]
  2. k1=127.0.0.1
  3. k2=127.0.0.2
  4. k3=127.0.0.3
  5. ;IP列表
复制代码
每行开头添加 ; 为注释
在C#中操作INI文件

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

  • WritePrivateProfileString():写操作函数
  • GetPrivateProfileString():读操作函数
写操作函数说明

函数声明

DllImport需引入命名空间 using System.Runtime.InteropServices;
  1.         /// <summary>
  2.         /// 修改INI文件内容
  3.         /// </summary>
  4.         /// <param name="lpApplicationName">节点名称(段落名称)section</param>
  5.         /// <param name="lpKeyName">要设置的项名,Key</param>
  6.         /// <param name="lpString">要写入的新字符串Value</param>
  7.         /// <param name="lpFileName">INI文件晚挣路径</param>
  8.         /// <returns>0表示失败,非零表示成功</returns>
  9.         [DllImport("kernel32")]
  10.         private static extern long WritePrivateProfileString
  11.             (string lpApplicationName,
  12.             string lpKeyName,
  13.             string lpString,
  14.             string lpFileName);
复制代码
调用
  1.         /// <summary>
  2.         /// 保存ini
  3.         /// </summary>
  4.         /// <param name="section">节点/段落名称</param>
  5.         /// <param name="key">项/Key名称</param>
  6.         /// <param name="value">值</param>
  7.         /// <param name="filePath">ini文件路径</param>
  8.         public static void WriteIniKeys(string section, string key, string value, string filePath)
  9.         {
  10.             WritePrivateProfileString(section, key, value, filePath);
  11.         }
  12.         /*
  13.          * 若value为null则会删除配置文件中对应的key
  14.          * 若key value为null则会删除对应的section
  15.         */
复制代码
读操作函数说明

函数声明

DllImport需引入命名空间 using System.Runtime.InteropServices;
  1.         /// <summary>
  2.         /// 获取INI中指定字符串
  3.         /// </summary>
  4.         /// <param name="lpAppName">节点名称(段落名称)section</param>
  5.         /// <param name="lpKeyName">项名,Key</param>
  6.         /// <param name="lpDefault">未找到指定项时返回的默认值</param>
  7.         /// <param name="lpReturnedString">指定一个字符串缓冲区,长度至少为nSize</param>
  8.         /// <param name="nSize">指定装载到lpReturnedString缓冲区的最大字符数量</param>
  9.         /// <param name="lpFileName">INI文件路径</param>
  10.         /// <returns>复制到lpReturnedString中的字节数量</returns>
  11.         [DllImport("kernel32")]
  12.         private static extern int GetPrivateProfileString
  13.             (string lpAppName,
  14.             string lpKeyName,
  15.             string lpDefault,
  16.             StringBuilder lpReturnedString,
  17.             int nSize,
  18.             string lpFileName);
复制代码
调用
  1.         /// <summary>
  2.         /// 根据section,key取值,并设置默认值
  3.         /// </summary>
  4.         /// <param name="section">节点/段落名称</param>
  5.         /// <param name="key">项/Key名称</param>
  6.         /// <param name="def">默认值</param>
  7.         /// <param name="filePath">文件路径</param>
  8.         /// <returns>返回指定内容,若不存在则返回默认值def</returns>
  9.         private static string ReadIniKeys(string section, string key, string def, string filePath)
  10.         {
  11.             StringBuilder temp = new StringBuilder(1024);
  12.             GetPrivateProfileString(section, key, def, temp, 1024, filePath);
  13.             return temp.ToString();
  14.         }
复制代码
以上为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】 我们会及时删除侵权内容,谢谢合作!

举报 回复 使用道具