C#学习记录——【实例】读写ini文件

『知识有两种,一种是你知道的,一种是你知道在哪里能找到的!』—— 塞缪尔·约翰逊

1、概念

C#读写ini文件之前要了解的概念:INI就是扩展名为"INI"的文件,其实他本身是个文本文件,可以用记事本打开,主要存放的是用户所做的选择或系统的各种参数。

虽然微软早已经建议在WINDOWS中用注册表代替INI文件,但是在实际应用中,INI文件仍然有用武之地,尤其现在绿色软件的流行,越来越多的程序将自己的一些配置信息保存到了INI文件中。

C#读写ini文件其实并不是普通的文本文件。它有自己的结构。由若干段落(SECTION)组成,在每个带括号的标题下面,是若干个以单个单词开头的关键字(KEYWORD)和一个等号,等号右边就是关键字的值(VALUE)。例如:

[Section1]  
    KeyWord1 = Value1  
    KeyWord2 = Value2  
    ...  
[Section2]  
    KeyWord3 = Value3  
    KeyWord4 = Value4 

SECTION项名称不能重复(中括号内是项名称)。
同一个项名称中关键字名不能重复。

增删改查操作代码

新增:如果ini文件不存在的话,可以直接新增文件并新增对应的值。

修改:修改和新增用的是相同的方法,如果值不存在就是新增,存在就是修改。

查询:查询用到的方法是GetPrivateProfileString,这个方法中的第三个参数def的含义是:无法读取时候时候的缺省数值,就是如果读取的键不存在,则返回def的值。第四个和第五个参数的含义是:读取的数值和数值的大小。

删除:删除用的也是和新增修改一样的方法,只不过写入的值为null即可。值得一提的是键值为null是删除当前键,键名为null是删除当前项。

系统处理INI的方法.

虽然C#中没有,但是在"kernel32.dll"这个文件中有Win32的API函数–WritePrivateProfileString()和GetPrivateProfileString()

2、说明

C#读写ini文件实现之C#声明INI文件的写操作函数WritePrivateProfileString():

[DllImport( "kernel32" )]  //-------返回0表示失败 非0为成功
  private static extern long WritePrivateProfileString (string section ,string key , string val , string filePath ) ; 

参数说明:

section:INI文件中的段落;

key:INI文件中的关键字;

val:INI文件中关键字的数值;

filePath:INI文件的完整的路径和名称。

C#读写ini文件实现之C#申明INI文件的读操作函数GetPrivateProfileString():

[DllImport("kernel32")]  //-------返回取得字符串缓冲区的长度
        private static extern long GetPrivateProfileString(string section, string key, string def, StringBuilder retVal, int size, string filePath);

参数说明:

section:INI文件中的段落名称;

key:INI文件中的关键字;

def:无法读取时候时候的缺省数值;

retVal:读取数值;

size:数值的大小;

filePath:INI文件的完整路径和名称。

下面是一个C#读写ini文件的类:

public class INIClass  
{  
 public string inipath;  
 [DllImport("kernel32")]  
 private static extern long WritePrivateProfileString(
string section,string key,string val,string filePath);  
 [DllImport("kernel32")]  
 private static extern int GetPrivateProfileString(
string section,string key,
string def,StringBuilder retVal,
int size,string filePath);  
 /// ﹤summary﹥  
 /// 构造方法  
 /// ﹤/summary﹥  
 /// ﹤param name="INIPath"﹥文件路径﹤/param﹥  
 public INIClass(string INIPath)  
 {  
  inipath = INIPath;  
 }  
 /// ﹤summary﹥  
 /// 写入INI文件  
 /// ﹤/summary﹥  
 /// ﹤param name="Section"﹥项目名称(如 [TypeName] )﹤/param﹥  
 /// ﹤param name="Key"﹥键﹤/param﹥  
 /// ﹤param name="Value"﹥值﹤/param﹥  
 public void IniWriteValue(string Section,string Key,string Value)  
 {  
  WritePrivateProfileString(Section,Key,Value,this.inipath);  
 }  
 /// ﹤summary﹥  
 /// 读出INI文件  
 /// ﹤/summary﹥  
 /// ﹤param name="Section"﹥项目名称(如 [TypeName] )﹤/param﹥  
 /// ﹤param name="Key"﹥键﹤/param﹥  
 public string IniReadValue(string Section,string Key)  
 {  
  StringBuilder temp = new StringBuilder(500);  
  int i = GetPrivateProfileString(Section,Key,"",temp,500,this.inipath);  
  return temp.ToString();  
 }  
 /// ﹤summary﹥  
 /// 验证文件是否存在  
 /// ﹤/summary﹥  
 /// ﹤returns﹥布尔值﹤/returns﹥  
 public bool ExistINIFile()  
 {  
  return File.Exists(inipath);  
 }  
} 

3、应用

3.1、应用说明

串口调试软件,将基本设置信息和中继设置信息保存到ini文件,及从ini文件恢复配置;
C#学习记录——【实例】读写ini文件_第1张图片

3.2、应用主要代码

1、api函数声明

主要代码:

#region api函数声明
        [DllImport("kernel32")]  //-------返回0表示失败 非0为成功
        private static extern long WritePrivateProfileString(string section, string key, string val, string filePath);
        [DllImport("kernel32")]  //-------返回取得字符串缓冲区的长度
        private static extern long GetPrivateProfileString(string section, string key, string def, StringBuilder retVal, int size, string filePath);
        #endregion

2、写入到ini文件

主要代码:

 #region 写ini文件
        ///
        ///ini文件中的节名
        ///ini 文件中的健
        ///要写入该健所对应的值
        ///ini文件路径
        ///
        public static bool WriteIniData(string Section, string key, string val, string inifilePath)
        {
            if (File.Exists(inifilePath))
            {
                long opSt = WritePrivateProfileString(Section, key, val, inifilePath);
                if (opSt == 0)
                {
                    return false;
                }
                else
                {
                    return true;
                }
            }
            else
            {
                CreateFile(inifilePath);
                long opSt = WritePrivateProfileString(Section, key, val, inifilePath);
                if (opSt == 0)
                {
                    return false;
                }
                else
                {
                    return true;
                }
            }
        }
        #endregion

3、读取ini文件

主要代码:

#region  读取ini文件
        /// 
        /// 
        /// 
        /// 节点名称
        /// 对应的key
        /// 读不到值时返回的默认值
        /// 文件路径
        /// 
        public static string ReadIniData(string section, string key, string noText, string iniFilePath)
        {
            if (File.Exists(iniFilePath))
            {
                StringBuilder temp = new StringBuilder(1024);
                long k = GetPrivateProfileString(section, key, noText, temp, 1024, iniFilePath);
                if (k != 0)
                {
                    return temp.ToString();
                }
                else
                {
                    return string.Empty;
                }
            }
            else
            {
                return string.Empty;
            }
        }
#endregion

4、创建文件

主要代码:

#region   创建文件
        public static void CreateFile(string path)
        {
            if (!string.IsNullOrEmpty(path))
            {
                try
                {
                    string dr = Path.GetDirectoryName(path);
 
                    if (!Directory.Exists(dr))
                    {
                        Directory.CreateDirectory(dr);
                    }
                    if (!File.Exists(path))
                    {
                        FileStream fs = File.Create(path);
 
                        fs.Close();
                    }
                }
                catch (Exception e)
                {
                    Log.LogHelper.Error("CreateFile()" + e.ToString());
                }
            }
        }
#endregion

5、简单调用

主要代码:

#region   把参数写入ini文件
        public bool savePwdToIni(string Section, string key, string pwd)
        {
            string path = System.AppDomain.CurrentDomain.BaseDirectory;
            path += "\\" + "ini" + "\\Configuration.ini";

            bool b = WriteIniData(Section, key, pwd, path);

            return b;
        }
        #endregion

        #region   从ini文件读取参数
        public string readPwdFromIni()
        {
            string path = System.AppDomain.CurrentDomain.BaseDirectory;
            path += "\\" + "ini" + "\\Configuration.ini";

            string s = ReadIniData("Section_1", "pwd", "", path);

            return s;
        }
        #endregion

4、结束语

目前C# 对ini文件操作基本上要被xml文件取代了,但是我觉得ini文件的读写仍然是编程的基本,是必须会的。

你可能感兴趣的:(C#学习记录,C#项目实战,c#,学习,开发语言)