C#如何读写和创建INI文件

在做项目过程中，有时需要保存一些简单的配置信息，可以使用xml，也可以使用INI文件。下面是C#中读取INI的方法，相信大部分朋友都使用过这种方式。
INI文件的存储方式如下，

[section]
key=value
key=value

读取写入方法，

[DllImport("kernel32")]
private static extern long WritePrivateProfileString(string section, string key, string val, string filePath);

[DllImport("kernel32")]
private static extern int GetPrivateProfileString(string lpAppName, string lpKeyName, string lpDefault, StringBuilder lpReturnedString, int nSize, string lpFileName);

[DllImport("kernel32.dll", CharSet = CharSet.Auto)]
private static extern uint GetPrivateProfileSection(string lpAppName, IntPtr lpReturnedString, uint nSize, string lpFileName);

private static string ReadString(string section, string key, string def, string filePath)
{
    StringBuilder temp = new StringBuilder(1024);

    try
    {
        GetPrivateProfileString(section, key, def, temp, 1024, filePath);
    }
    catch
    { }
    return temp.ToString();
}
/// <summary>
/// 根据section取所有key
/// </summary>
/// <param name="section"></param>
/// <param name="filePath"></param>
/// <returns></returns>
public static string[] ReadIniAllKeys(string section,string filePath)
{
    UInt32 MAX_BUFFER = 32767;

    string[] items = new string[0];

    IntPtr pReturnedString = Marshal.AllocCoTaskMem((int)MAX_BUFFER * sizeof(char));

    UInt32 bytesReturned = GetPrivateProfileSection(section, pReturnedString, MAX_BUFFER, filePath);

    if (!(bytesReturned == MAX_BUFFER - 2) || (bytesReturned == 0))
    {
        string returnedString = Marshal.PtrToStringAuto(pReturnedString, (int)bytesReturned);

        items = returnedString.Split(new char[] { '' }, StringSplitOptions.RemoveEmptyEntries);
    }

    Marshal.FreeCoTaskMem(pReturnedString);

    return items;
}

/// <summary>
/// 根据section，key取值
/// </summary>
/// <param name="section"></param>
/// <param name="keys"></param>
/// <param name="filePath">ini文件路径</param>
/// <returns></returns>
public static string ReadIniKeys(string section, string keys, string filePath)
{
    return ReadString(section, keys, "", filePath);
}

/// <summary>
/// 保存ini
/// </summary>
/// <param name="section"></param>
/// <param name="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);
}

如果要删除某一项：

WriteIniKeys(section, key, null, recordIniPath);

如上就可以读取和写入了，那么INI文件如何创建呢？

[DllImport("kernel32")]
public static extern long WritePrivateProfileString(string section, string key, string value, string iniPath);

调用该方法，即可创建你的ini文件和想要保存的值。

当然上面的ini操作并不是很详细的，以下从http://blog.csdn.net/sdfkfkd/article/details/7050733的博客转载的一片描述INI操作的，比较详细，值得学习。

public class INIOperationClass
{

    #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">存放节点名称的内存地址,每个节点之间用分隔</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">返回值的内存地址,每个之间用分隔</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中所有节点名称,每个节点名称之间用分隔</param>
    /// <param name="lpKeyName">Key名称。如果为null,则读取INI中指定节点中的所有KEY,每个KEY之间用分隔</param>
    /// <param name="lpDefault">读取失败时的默认值</param>
    /// <param name="lpReturnedString">读取的内容缓冲区，读取之后，多余的地方使用填充</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 作为缓冲区类型的缺点是不能接受字符，会将及其后的字符截断,
    //所以对于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键值对，多个用分隔,形如key1=value1key2=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 = INIOperationClass.GetPrivateProfileSectionNames(pReturnedString, MAX_BUFFER, iniFile);
        if (bytesReturned != 0)
        {
            //读取指定内存的内容
            string local = Marshal.PtrToStringAuto(pReturnedString, (int)bytesReturned).ToString();

            //每个节点之间用分隔,末尾有一个
            sections = local.Split(new char[] { '' }, 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 = INIOperationClass.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[] { '' }, 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 = INIOperationClass.GetPrivateProfileString(section, null, null, chars, SIZE, iniFile);

        if (bytesReturned != 0)
        {
            value = new string(chars).Split(new char[] { '' }, 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 = INIOperationClass.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">键值对，多个用分隔,形如key1=value1key2=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 INIOperationClass.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 INIOperationClass.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 INIOperationClass.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 INIOperationClass.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 INIOperationClass.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=文件View=视图Edit=编辑");

        //获取文件中所有的节点
        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
}