Click here to Skip to main content
Licence 
First Posted 14 Mar 2002
Views 368,165
Bookmarked 110 times

An INI file handling class using C#

By | 14 Mar 2002 | Article
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

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

About the Author

BLaZiNiX

Web Developer

Canada Canada

Member



Sign Up to vote   Poor Excellent
Add a reason or comment to your vote: x
Votes of 3 or less require a comment

Comments and Discussions

 
You must Sign In to use this message board. (secure sign-in)
 
Search this forum  
 FAQ
    Noise  Layout  Per page   
  Refresh
Questionmy vote of 5 Pinmembervelt_99121:09 24 Apr '12  
QuestionIf you want to support unicode, use this. Pinmemberchozekun21:11 12 Mar '12  
GeneralMy vote of 5 Pinmemberkoiser3:51 13 Feb '12  
GeneralMy vote of 5 Pinmembersanket_14@rediff.com20:40 1 Nov '11  
GeneralMy vote of 5 PinmemberAli Fakoor21:44 21 Oct '11  
QuestionRead and write ini files in VB.Net PinmemberNasenbaaer3:46 5 Oct '11  
GeneralMy vote of 5 PinmemberNasenbaaer3:45 5 Oct '11  
Questionhave 5 stars PinmemberShivamkalra18:57 22 Jun '11  
Question5 star PinmemberShivamkalra18:56 22 Jun '11  
RantOK Pinmembermebaba23:06 12 May '11  
GeneralMy vote of 5 PinmemberMember 4458079 Jose15:35 5 May '11  
GeneralMy vote of 5 Pinmemberdv7622:20 17 Mar '11  
Generalsuggestion to add some more methods to this class. Pinmemberhugoandrioli@yahoo.com0:15 28 Dec '10  
GeneralRe: suggestion to add some more methods to this class. Pinmembermd5sum9:28 5 Jan '11  
GeneralRe: suggestion to add some more methods to this class. Pinmember(^-^)h~ugo11:45 5 Jan '11  
GeneralRe: suggestion to add some more methods to this class. [modified] Pinmembermd5sum12:02 5 Jan '11  
GeneralRe: suggestion to add some more methods to this class. Pinmembertttony0715:48 6 Mar '11  
GeneralStrings longer than 254 characters will be truncated. Pinmemberdgph17:34 21 Nov '10  
GeneralMy vote of 3 PinmemberDaniel Moreland12:10 4 Nov '10  
GeneralUnable to add multiple record Pinmembersammizai23:58 4 Oct '10  
AnswerRe: Unable to add multiple record Pinmembershrutigupta217:49 24 Dec '10  
GeneralGreat Job Pinmembersos.crow16:50 16 Jul '09  
GeneralCode Update! PinmemberBenjamin Ethington9:31 16 Jun '09  
GeneralRe: Code Update! - ConvertIni2Xml PinmemberThymine8:27 4 Aug '09  
GeneralRe: Code Update! Pinmemberthund3rstruck4:46 18 Sep '09  

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

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

Permalink | Advertise | Privacy | Mobile
Web04 | 2.5.120517.1 | Last Updated 15 Mar 2002
Article Copyright 2002 by BLaZiNiX
Everything else Copyright © CodeProject, 1999-2012
Terms of Use
Layout: fixed | fluid