Click here to Skip to main content
14,926,224 members
Articles / Programming Languages / C#
Article
Posted 14 Mar 2002

Stats

781.8K views
19K downloads
166 bookmarked

An INI file handling class using C#

Rate me:
Please Sign up or sign in to vote.
4.79/5 (121 votes)
14 Mar 2002
A C# class that exposes the INI file handling functions from Kernal32.dll

Introduction

I created a C# class Ini which exposes 2 functions from KERNEL32.dll. These functions are: WritePrivateProfileString and

GetPrivateProfileString

Namespaces you will need: System.Runtime.InteropServices and System.Text

The Class

C#
using System;
using System.Runtime.InteropServices;
using System.Text;

namespace Ini
{
    /// <summary>
    /// Create a New INI file to store or load data
    /// </summary>
    public class IniFile
    {
        public string path;

        [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>
        /// INIFile Constructor.
        /// </summary>
        /// <PARAM name="INIPath"></PARAM>
        public IniFile(string INIPath)
        {
            path = INIPath;
        }
        /// <summary>
        /// Write Data to the INI File
        /// </summary>
        /// <PARAM name="Section"></PARAM>
        /// Section name
        /// <PARAM name="Key"></PARAM>
        /// Key Name
        /// <PARAM name="Value"></PARAM>
        /// Value Name
        public void IniWriteValue(string Section,string Key,string Value)
        {
            WritePrivateProfileString(Section,Key,Value,this.path);
        }
        
        /// <summary>
        /// Read Data Value From the Ini File
        /// </summary>
        /// <PARAM name="Section"></PARAM>
        /// <PARAM name="Key"></PARAM>
        /// <PARAM name="Path"></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();

        }
    }
}

Using the class

Steps to use the Ini class:

  1. In your project namespace definition add 
    using INI;
  2. Create a INIFile like this
    INIFile ini = new INIFile("C:\\test.ini");
  3. Use IniWriteValue to write a new value to a specific key in a section or use IniReadValue to read a value FROM a key in a specific Section.

That's all. It's very easy in C# to include API functions in your class(es).

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

Share

About the Author

BLaZiNiX
Web Developer
Canada Canada
No Biography provided

Comments and Discussions

 
GeneralMy vote of 5 Pin
Member 4458079 Jose5-May-11 15:35
MemberMember 4458079 Jose5-May-11 15:35 
GeneralMy vote of 5 Pin
dv7617-Mar-11 22:20
Memberdv7617-Mar-11 22:20 
Generalsuggestion to add some more methods to this class. Pin
(^-^)h~ugo28-Dec-10 0:15
Member(^-^)h~ugo28-Dec-10 0:15 
GeneralRe: suggestion to add some more methods to this class. Pin
md5sum5-Jan-11 9:28
Membermd5sum5-Jan-11 9:28 
GeneralRe: suggestion to add some more methods to this class. Pin
(^-^)h~ugo5-Jan-11 11:45
Member(^-^)h~ugo5-Jan-11 11:45 
GeneralRe: suggestion to add some more methods to this class. [modified] Pin
md5sum5-Jan-11 12:02
Membermd5sum5-Jan-11 12:02 
GeneralRe: suggestion to add some more methods to this class. Pin
tttony076-Mar-11 15:48
Membertttony076-Mar-11 15:48 
GeneralRe: suggestion to add some more methods to this class. Pin
Member 922029317-Feb-14 8:55
MemberMember 922029317-Feb-14 8:55 
You can add GetPrivateProfileSectionNames method in the class. I find it really usefull.

[DllImport("kernel32")]
private static extern uint GetPrivateProfileSectionNames(byte[] lpszReturnBuffer,
     int nSize, string lpFileName);

public List<String> IniSectionNames()
{
     byte[] buff = new byte[1024];
     GetPrivateProfileSectionNames(buff, buff.Length, this._path);
     String s = Encoding.Default.GetString(buff);
     String[] names = s.Split('\0');

     return names.Where(n => n != string.Empty).ToList();
}

GeneralStrings longer than 254 characters will be truncated. Pin
dgph21-Nov-10 17:34
Memberdgph21-Nov-10 17:34 
GeneralRe: Strings longer than 254 characters will be truncated. Pin
f.rivato16-Jan-13 21:35
Memberf.rivato16-Jan-13 21:35 
GeneralMy vote of 3 Pin
Daniel Moreland4-Nov-10 12:10
MemberDaniel Moreland4-Nov-10 12:10 
GeneralUnable to add multiple record Pin
sammizai4-Oct-10 23:58
Membersammizai4-Oct-10 23:58 
AnswerRe: Unable to add multiple record Pin
shrutigupta2124-Dec-10 7:49
Membershrutigupta2124-Dec-10 7:49 
GeneralRe: Unable to add multiple record Pin
kytro36028-Oct-12 5:53
Memberkytro36028-Oct-12 5:53 
GeneralGreat Job Pin
sos.crow16-Jul-09 16:50
Membersos.crow16-Jul-09 16:50 
GeneralCode Update! Pin
Benjamin Ethington16-Jun-09 9:31
MemberBenjamin Ethington16-Jun-09 9:31 
GeneralRe: Code Update! - ConvertIni2Xml Pin
Thymine4-Aug-09 8:27
MemberThymine4-Aug-09 8:27 
GeneralRe: Code Update! Pin
thund3rstruck18-Sep-09 4:46
Memberthund3rstruck18-Sep-09 4:46 
GeneralAdded some methods to manage additional data types (read) Pin
Nyarlatotep15-Jun-09 23:42
MemberNyarlatotep15-Jun-09 23:42 
GeneralRe: Added some methods to manage additional data types (read) Pin
Ali Fakoor21-Oct-11 21:25
MemberAli Fakoor21-Oct-11 21:25 
GeneralRe: Added some methods to manage additional data types (read) Pin
Nyarlatotep21-Oct-11 21:40
MemberNyarlatotep21-Oct-11 21:40 
GeneralUsing this class in a aspx web application Pin
Scott Reid4-Mar-09 12:47
MemberScott Reid4-Mar-09 12:47 
GeneralHits the spot Pin
HibbertM13-Feb-09 0:23
MemberHibbertM13-Feb-09 0:23 
GeneralThanks Pin
NAMhatre18-Sep-08 7:47
MemberNAMhatre18-Sep-08 7:47 
Questionlicensing? Pin
Nick Trown14-Aug-08 10:47
MemberNick Trown14-Aug-08 10:47 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.