.ini配置文件书写格式（转）

为什么要用INI文件？如果我们程序没有任何配置文件时，这样的程序对外是全封闭的，一旦程序需要修改一些参数必须要修改程序代码本身并重新编译，这样很不好，所以要用配置文件，让程序出厂后还能根据需要进行必要的配置；配置文件有很多如INI配置文件，XML配置文件，还有就是可以使用系统注册表等。

          本文主要是为读者在实现读写INI配置文件模块之前，提供有关INI文件的格式信息。

在早期的windows桌面系统中主要是用INI文件作为系统的配置文件，从win95以后开始转向使用注册表，但是还有很多系统配置是使用INI文件的。其实INI文件就是简单的text文件，只不过这种txt文件要遵循一定的INI文件格式。现在的WINCE系统上也常常用INI文件作为配置文件，这次研究INI文件的目的就是为了我的GPS定位系统客户端写个系统配置文件。“.INI ”就是英文 “initialization”的头三个字母的缩写；当然INI file的后缀名也不一定是".ini"也可以是".cfg"，".conf ”或者是".txt"。

 

经典格式：

INI文件的格式很简单，最基本的三个要素是：parameters，sections和comments。

什么是parameters？

INI所包含的最基本的“元素”就是parameter；每一个parameter都有一个name和一个value，name和value是由等号“=”隔开。name在等号的左边。

如：

      name = value

什么是sections ？

所有的parameters都是以sections为单位结合在一起的。所有的section名称都是独占一行，并且sections名字都被方括号包围着（[ and ])。在section声明后的所有parameters都是属于该section。对于一个section没有明显的结束标志符，一个section的开始就是上一个section的结束，或者是end of the file。Sections一般情况下不能被nested，当然特殊情况下也可以实现sections的嵌套。

section如下所示：

         [section]

 

什么是comments ？

在INI文件中注释语句是以分号“；”开始的。所有的所有的注释语句不管多长都是独占一行直到结束的。在分号和行结束符之间的所有内容都是被忽略的。

注释实例如下：

；comments text

 

当然，上面讲的都是最经典的INI文件格式，随着使用的需求INI文件的格式也出现了很多变种；

INI实例：

; last modified 1 April 2001 by John Doe
[owner]
name=John Doe
organization=Acme Products

[database]
server=192.0.2.42 ; use IP address in case network name resolution is not working
port=143
file = "acme payroll.dat"

 

变种格式：

 请参考：http://en.wikipedia.org/wiki/INI_file

http://blog.163.com/lyzaily@126/blog/static/42438837200911901541762/

 

 

/*****************************************************************/

转自：http://hi.baidu.com/ykhykh/blog/item/ad3aba31119e2aab5fdf0e44.html

概述

在程序中经常要用到设置或者其他少量数据的存盘，以便程序在下一次执行的时候可以使用，比如说保存本次程序执行时窗口的位置、大小、一些用户设置的数据等等，在 Dos 下编程的时候，我们一般自己产生一个文件，由自己把这些数据写到文件中，然后在下一次执行的时候再读出来使用。在 Win32 编程中当然你也可以这样干，但 Windows 已经为我们提供了两种方便的办法，那就是使用注册表或者 ini 文件（Profile）来保存少量数据。本文中先介绍一下 .ini 文件的使用。

ini 文件是文本文件，中间的数据格式一般为： 
[Section1 Name] 
KeyName1=value1 
KeyName2=value2 
...

[Section2 Name] 
KeyName1=value1 
KeyName2=value2

ini 文件可以分为几个 Section，每个 Section 的名称用 [] 括起来，在一个 Section 中，可以有很多的 Key，每一个 Key 可以有一个值并占用一行，格式是 Key=value，Win32 对 ini 文件操作的 api 中，有一部分是对 win.ini 操作的，有一部分是对用户自定义的 ini 文件操作的。Win.in 和 system.ini 是Windows的两个非常重要的初始化文件，Windows将用户所作的选择以及各种变化的系统信息记录在这两个文件中。System.ini 描述了系统硬件的当前状态，Win.ini 文件则包含了Windows 系统运行环境的当前配置。由于 Win.ini 文件的重要性和常用性，Win32 中有专门对 Win.ini 进行操作的 api，它们是：

GetProfileInt - 从 Win.ini 文件的某个 Section 取得一个 key 的整数值，它的原形是：

GetProfileInt( 
LPCTSTR lpAppName, // 指向包含 Section 名称的字符串地址 
LPCTSTR lpKeyName, // 指向包含 Key 名称的字符串地址 
INT nDefault // 如果 Key 值没有找到，则返回缺省的值是多少 
);

如果 Key 值没有找到的话，返回值是 nDefault 指定的缺省值，如果 Key 中的值是负数，则返回 0，如果 Key 指定的是数字和字符串的混合，则返回数字部分的值，比如说 x=1234abcd，则返回 1234

GetProfileString - 从 Win.ini 文件的某个 Section 取得一个 key 的字符串，它的原形是：

GetProfileString( 
LPCTSTR lpAppName, // 指向包含 Section 名称的字符串地址 
LPCTSTR lpKeyName, // 指向包含 Key 名称的字符串地址 
LPCTSTR lpDefault, // 如果 Key 值没有找到，则返回缺省的字符串的地址 
LPTSTR lpReturnedString, // 返回字符串的缓冲区地址 
DWORD nSize // 缓冲区的长度 
);

返回的字符串在缓冲区内，返回的 eax 值是返回的字符串的长度（不包括尾部的0）

GetProfileSection - 从 Win.ini 文件中读出整个 Section 的内容，它的原形是：

GetProfileSection( 
LPCTSTR lpAppName, // 指向包含 Section 名称的字符串地址 
LPTSTR lpReturnedString, // 返回数据的缓冲区地址 
DWORD nSize // 返回数据的缓冲区长度 
);

WriteProfileSection - 将一个整个 Section 的值 写入 Win.ini 文件的指定 Section 中，它的原形是：

WriteProfileSection( 
LPCTSTR lpAppName, // 指向包含 Section 名称的字符串地址 
LPCTSTR lpString // 要写入的数据的地址 
);

如果 Win.ini 没有指定的 Section，API 会新建立一个并写入数据，如果已经存在，则先删除原来 Seciton 中所有的 Key 值然后写入新的。

WriteProfileString - 将一个 Key 值写入 Win.ini 文件的指定 Section 中，它的原形是：

WriteProfileString( 
LPCTSTR lpAppName, // 指向包含 Section 名称的字符串地址 
LPCTSTR lpKeyName, // 指向包含 Key 名称的字符串地址 
LPCTSTR lpString // 要写的字符串地址 
);

如果 Win.ini 没有指定的 Section，API 会新建 Section，如果没有指定的 Key 则新建一个 Key 并写入数据，如果已经存在，则用字符串代替原来的值。 
以上的 Api 是对 Win.ini 操作的，当然对于我们来说，用的更多的是在程序运行的目录中建立自己的 ini 文件，如果需要对自己的 ini 文件操作，就要用到另一组 Api，这一组 api 和上面的很象，只要把上面一组的 Profile 换成 PrivateProfile（私有的）就可以了，参数中也相应的多了一个 ini 文件名的参数。例如 GetPrivateProfileInt、GetPrivateProfileSection、WritePrivateProfileString 等等， 下面分别介绍：

GetPrivateProfileInt - 从 ini 文件的某个 Section 取得一个 key 的整数值，它的原形是：

GetPrivateProfileInt( 
LPCTSTR lpAppName, // 指向包含 Section 名称的字符串地址 
LPCTSTR lpKeyName, // 指向包含 Key 名称的字符串地址 
INT nDefault // 如果 Key 值没有找到，则返回缺省的值是多少 
LPCTSTR lpFileName // ini 文件的文件名 
);

中间参数和返回值的定义和 GetProfileInt 是一样的。

GetPrivateProfileString - 从 ini 文件的某个 Section 取得一个 key 的字符串，它的原形是：

GetPrivateProfileString( 
LPCTSTR lpAppName, // 指向包含 Section 名称的字符串地址 
LPCTSTR lpKeyName, // 指向包含 Key 名称的字符串地址 
LPCTSTR lpDefault, // 如果 Key 值没有找到，则返回缺省的字符串的地址 
LPTSTR lpReturnedString, // 返回字符串的缓冲区地址 
DWORD nSize // 缓冲区的长度 
LPCTSTR lpFileName // ini 文件的文件名 
);

GetPrivateProfileSection - 从 ini 文件中读出整个 Section 的内容，它的原形是：

GetPrivateProfileSection( 
LPCTSTR lpAppName, // 指向包含 Section 名称的字符串地址 
LPTSTR lpReturnedString, // 返回数据的缓冲区地址 
DWORD nSize // 返回数据的缓冲区长度 
LPCTSTR lpFileName // ini 文件的文件名 
);

这个 api 可以读出整个 section 的内容，当你不知道 section 中有哪些 key 的时候，可以使用这个 api 将整个 section 读出后再处理。

GetPrivateProfileSectionNames - 从 ini 文件中获得 Section 的名称，它的原形是：

GetPrivateProfileSectionNames( 
LPTSTR lpszReturnBuffer, // 返回数据的缓冲区地址 
DWORD nSize // 返回数据的缓冲区长度 
LPCTSTR lpFileName // ini 文件的文件名 
);

如果 ini 中有两个 Section: [sec1] 和 [sec2]，则返回的是 'sec1',0,'sec2',0,0 ，当你不知道 ini 中有哪些 section 的时候可以用这个 api 来获取名称

WritePrivateProfileSection - 将一个整个 Section 的内容入 ini 文件的指定 Section 中，它的原形是：

WritePrivateProfileSection( 
LPCTSTR lpAppName, // 指向包含 Section 名称的字符串地址 
LPCTSTR lpString // 要写入的数据的地址 
LPCTSTR lpFileName // ini 文件的文件名 
);

WritePrivateProfileString - 将一个 Key 值写入 ini 文件的指定 Section 中，它的原形是：

WritePrivateProfileString( 
LPCTSTR lpAppName, // 指向包含 Section 名称的字符串地址 
LPCTSTR lpKeyName, // 指向包含 Key 名称的字符串地址 
LPCTSTR lpString // 要写的字符串地址 
LPCTSTR lpFileName // ini 文件的文件名 
);

如果 ini 中没有指定的 Section，API 会新建 Section，如果没有指定的 Key 则新建一个 Key 并写入数据，如果已经存在，则用字符串代替原来的值。当指定的 ini 也不存在的时候，API 会自动建立一个新的文件，所以使用 ini 的好处是我们不必为了保存少量的数据涉及到文件操作，就连查找文件是否存在的操作都不必要。

使用要点：

在我们实际使用的时候，用的最多的是 GetPrivateProfileString 和 WritePrivateProfileString，但在对自定义 ini 文件操作的时候要注意的是，如果 lpFileName 指定的文件没有路径的话，Api 会去 Windows 的安装目录去找而不会在当前目录找，但是每次用到 ini 函数要获取当前路径显然太麻烦了，这里有一个变通的办法，你只要在 ini 文件名前面加上 .\ 就可以了，比如说要对本目录下的 user.ini 操作，那么文件名就是 '.\user.ini' 这样显然比较方便。另外，当你要把一个 Key 清除的时候，可以使用把 lpString 指向一个空的字符串然后使用 WritePrivateProfileString。当你要把一个 section 的全部内容清空的时候，也不必把 key 一个个的清除，可以使用把 lpString 指向一个空的字符串然后使用 WritePrivateProfileSection。

INI文件就是扩展名为“ini”的文件。在Windows系统中，INI文件是很多，最重要的就是“System.ini”、“System32.ini”和“Win.ini”。该文件主要存放用户所做的选择以及系统的各种参数。用户可以通过修改INI文件，来改变应用程序和系统的很多配置。但自从Windows 95的退出，在Windows系统中引入了注册表的概念，INI文件在Windows系统的地位就开始不断下滑，这是因为注册表的独特优点，使应用程序和系统都把许多参数和初始化信息放进了注册表中。

读写配置文件实例

using System;
using System.Collections.Generic;
using System.Text;
using System.Runtime.InteropServices;

namespace myApp
{
     /// <summary>
     ///   对以ini结尾的配置文件的读写的类。配置文件的格式为
     /// [Section1 Name] 
     /// KeyName1=value1 
     /// KeyName2=value2 
     /// [Section2 Name] 
     /// KeyName1=value1 
     /// KeyName2=value2 
     /// </summary>
     class IniFile
     {
         private string path;

         public string Path
         {
             get { return path; }
             set { path = value; }
         }
         
         [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>
         /// 对以ini结尾的配置文件的读写的类
         /// </summary>
         /// <param name="INIPath">ini文件的路径</param>
           public IniFile(string INIPath)
         {
　             path = INIPath;
　         }

         
         /// <summary>
         /// 将一个 Key 值写入 Win.ini 文件的指定 Section 中，
         /// 如果没有指定的 Key 则新建一个 Key 并写入数据，如果已经存在，则用字符串代替原来的值。 
         /// </summary>
         /// <param name="Section">指向包含 Section 名称的字符串地址 </param>
         /// <param name="Key">指向包含 Key 名称的字符串地址</param>
         /// <param name="Value">要写的字符串</param>
         public void IniWriteValue(string Section, string Key, string Value)
         {

             WritePrivateProfileString(Section, Key, Value, this.path);

         }

         /// <summary>
         /// 从 ini 文件的某个 Section 取得一个 key 的字符串
         /// </summary>
         /// <param name="Section">指向包含 Section 名称的字符串地址</param>
         /// <param name="Key">指向包含 Key 名称的字符串地址</param>
         /// <returns>返回字符串</returns>
         public string IniReadValue(string Section, string Key)
         {
             StringBuilder temp = new StringBuilder(255);
             int i = GetPrivateProfileString(Section, Key, "", temp,255, this.path);
             return temp.ToString();
         }

     }
}