ini文件总结
ini文件文件扩展名
INI文件格式是某些平台或软件上的配置文件的非正式标准,以节(section)和键(key)构成,常用于微软Windows操作系统中。这种配置文件的文件扩展名多为INI,故名。
INI是英文“初始化”(initialization)的缩写。正如该术语所表示的,INI文件被用来对操作系统或特定程序初始化或进行参数设置。
文件格式
节(section)
节用括号括起来,独占一行。
[section]
键(key)
键又名关键字,单独占一行,用等号连接键名与键值。INI文件允许有许多个小节,每个小节又允许有多个关键字。
值的类型有三种:字符串、整数数值、布尔值。其中字符串储存在INI文件时没有引号,布尔真值用1表示,布尔假值用0表示。
name=value
注解(comment)
用使用英文分号 (;)在分号后面的文字,直至结尾都全部为注解。
;comment text
文件读写
由于INI文件是纯文本格式,所以可以用任何纯文本编辑器来进行编辑其内容。
由于C#的类库不包含读取INI文件的类,所以c#读取INI文件时采用windows的API函数
C#
网上的实例,可以直接用。见参考3
using System;
using System.Collections.Generic;
using System.Linq;
using System.Runtime.InteropServices;
using System.Text;
using System.Threading.Tasks;
namespace INIFile
{
public class INIFile
{
#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 = INIFile.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 = INIFile.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 = INIFile.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 = INIFile.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 INIFile.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 INIFile.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 INIFile.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 INIFile.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 INIFile.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
}
}
调用
//写
string exePath = System.IO.Directory.GetCurrentDirectory() + @"\Config.ini";
INIFile.INIFile.INIWriteValue(exePath, "Config", "txtPo", txtPo.Text.Trim());
//读
string[] config1 = INIFile.INIFile.INIGetAllItems(exePath, "Config");
txtPo.Text = config1[0].Substring(config1[0].LastIndexOf("=") + 1);
Python
Python的ConfigParser类
#!/usr/bin/env python
# -*- coding: UTF-8 -*-
import ConfigParser
iniparser = ConfigParser.ConfigParser()# 初始化一个INI读写类的对象
iniparser.read('filename.ini') # 读取INI文件
key_value = iniparser.get('section_name_1', 'key_name') # 解析INI文件
print key_value
# 生成INI文件
iniparser.add_section('section_name_2')
iniparser.set('section_name_2', 'key_name', 'key_value')
with open('filename.ini', 'w') as inifile:
iniparser.write(inifile) # 写入INI文件