Click here to Skip to main content
11,490,973 members (60,731 online)
Click here to Skip to main content

An INI file handling class using C#

, 14 Mar 2002 546.7K 13.3K 139
Rate this:
Please Sign up or sign in to vote.
A C# class that exposes the INI file handling functions from Kernal32.dll
<!-- Download Links --> <!-- Add the rest of your HTML here -->

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

Share

About the Author

BLaZiNiX
Web Developer
Canada Canada
No Biography provided

Comments and Discussions

 
GeneralMy vote of 1 Pin
Member 1050939219-Nov-14 13:23
memberMember 1050939219-Nov-14 13:23 
QuestionCann't able to Write values in Ini file Pin
Devendra lodha16-Oct-14 0:36
memberDevendra lodha16-Oct-14 0:36 
AnswerRe: Cann't able to Write values in Ini file Pin
Garth J Lancaster16-Oct-14 0:56
memberGarth J Lancaster16-Oct-14 0:56 
GeneralRe: Cann't able to Write values in Ini file Pin
Devendra lodha16-Oct-14 1:14
memberDevendra lodha16-Oct-14 1:14 
GeneralRe: Cann't able to Write values in Ini file Pin
Garth J Lancaster16-Oct-14 1:42
memberGarth J Lancaster16-Oct-14 1:42 
Questionwhat WritePrivateProfileString returns Pin
Devendra lodha15-Oct-14 22:51
memberDevendra lodha15-Oct-14 22:51 
Questionmy vote i 5 of 5 Pin
TorbjornWave2-Oct-14 1:54
memberTorbjornWave2-Oct-14 1:54 
GeneralMy Vote of 5 Pin
Szymon Roslowski6-Aug-14 6:49
memberSzymon Roslowski6-Aug-14 6:49 
QuestionSimple and great class Pin
Member 1038226927-Apr-14 3:41
memberMember 1038226927-Apr-14 3:41 
SuggestionSuggestion Pin
Nathan Ferreira Dos Santos30-Jan-14 14:41
memberNathan Ferreira Dos Santos30-Jan-14 14:41 
GeneralMy vote of 5 Pin
Elena Futornyak14-Jun-13 2:16
memberElena Futornyak14-Jun-13 2:16 
Questionoverwriting Pin
Member 998609411-Jun-13 17:06
memberMember 998609411-Jun-13 17:06 
GeneralMy vote of 5 Pin
Amogh Natu27-May-13 5:52
professionalAmogh Natu27-May-13 5:52 
GeneralMy vote of 5 Pin
jai_magical16-Apr-13 12:40
memberjai_magical16-Apr-13 12:40 
GeneralMy vote of 5 Pin
Saravanan.rex5-Sep-12 5:00
memberSaravanan.rex5-Sep-12 5:00 
GeneralRe: My vote of 5 Pin
Headzup27-Sep-12 3:16
memberHeadzup27-Sep-12 3:16 
GeneralRe: My vote of 5 Pin
Saravanan.rex27-Sep-12 8:23
memberSaravanan.rex27-Sep-12 8:23 
QuestionFormClosing Pin
paphnuty27-Aug-12 22:38
memberpaphnuty27-Aug-12 22:38 
Questionmy vote of 5 Pin
velt_99124-Apr-12 22:09
membervelt_99124-Apr-12 22:09 
QuestionIf you want to support unicode, use this. Pin
chozekun12-Mar-12 22:11
memberchozekun12-Mar-12 22:11 
GeneralMy vote of 5 Pin
koiser13-Feb-12 4:51
memberkoiser13-Feb-12 4:51 
GeneralMy vote of 5 Pin
sanket_14@rediff.com1-Nov-11 21:40
membersanket_14@rediff.com1-Nov-11 21:40 
GeneralMy vote of 5 Pin
Ali Fakoor21-Oct-11 22:44
memberAli Fakoor21-Oct-11 22:44 
QuestionRead and write ini files in VB.Net Pin
Nasenbaaer5-Oct-11 4:46
memberNasenbaaer5-Oct-11 4:46 
GeneralMy vote of 5 Pin
Nasenbaaer5-Oct-11 4:45
memberNasenbaaer5-Oct-11 4:45 
Questionhave 5 stars Pin
Shivamkalra22-Jun-11 19:57
memberShivamkalra22-Jun-11 19:57 
Question5 star Pin
Shivamkalra22-Jun-11 19:56
memberShivamkalra22-Jun-11 19:56 
RantOK Pin
mebaba13-May-11 0:06
membermebaba13-May-11 0:06 
GeneralMy vote of 5 Pin
Member 4458079 Jose5-May-11 16:35
memberMember 4458079 Jose5-May-11 16:35 
GeneralMy vote of 5 Pin
dv7617-Mar-11 23:20
memberdv7617-Mar-11 23:20 
Generalsuggestion to add some more methods to this class. Pin
hugoandrioli@yahoo.com28-Dec-10 1:15
memberhugoandrioli@yahoo.com28-Dec-10 1:15 
GeneralRe: suggestion to add some more methods to this class. Pin
md5sum5-Jan-11 10:28
membermd5sum5-Jan-11 10:28 
GeneralRe: suggestion to add some more methods to this class. Pin
(^-^)h~ugo5-Jan-11 12:45
member(^-^)h~ugo5-Jan-11 12:45 
GeneralRe: suggestion to add some more methods to this class. [modified] Pin
md5sum5-Jan-11 13:02
membermd5sum5-Jan-11 13:02 
GeneralRe: suggestion to add some more methods to this class. Pin
tttony076-Mar-11 16:48
membertttony076-Mar-11 16:48 
GeneralRe: suggestion to add some more methods to this class. Pin
Member 922029317-Feb-14 9:55
memberMember 922029317-Feb-14 9:55 
GeneralStrings longer than 254 characters will be truncated. Pin
dgph21-Nov-10 18:34
memberdgph21-Nov-10 18:34 
GeneralRe: Strings longer than 254 characters will be truncated. Pin
f.rivato16-Jan-13 22:35
memberf.rivato16-Jan-13 22:35 
GeneralMy vote of 3 Pin
Daniel Moreland4-Nov-10 13:10
memberDaniel Moreland4-Nov-10 13:10 
GeneralUnable to add multiple record Pin
sammizai5-Oct-10 0:58
membersammizai5-Oct-10 0:58 
AnswerRe: Unable to add multiple record Pin
shrutigupta2124-Dec-10 8:49
membershrutigupta2124-Dec-10 8:49 
GeneralRe: Unable to add multiple record Pin
kytro36028-Oct-12 6:53
memberkytro36028-Oct-12 6:53 
GeneralGreat Job Pin
sos.crow16-Jul-09 17:50
membersos.crow16-Jul-09 17:50 
GeneralCode Update! Pin
Benjamin Ethington16-Jun-09 10:31
memberBenjamin Ethington16-Jun-09 10:31 
GeneralRe: Code Update! - ConvertIni2Xml Pin
Thymine4-Aug-09 9:27
memberThymine4-Aug-09 9:27 
GeneralRe: Code Update! Pin
thund3rstruck18-Sep-09 5:46
memberthund3rstruck18-Sep-09 5:46 
GeneralAdded some methods to manage additional data types (read) Pin
Nyarlatotep16-Jun-09 0:42
memberNyarlatotep16-Jun-09 0:42 
GeneralRe: Added some methods to manage additional data types (read) Pin
Ali Fakoor21-Oct-11 22:25
memberAli Fakoor21-Oct-11 22:25 
GeneralRe: Added some methods to manage additional data types (read) Pin
Nyarlatotep21-Oct-11 22:40
memberNyarlatotep21-Oct-11 22:40 
GeneralUsing this class in a aspx web application Pin
Scott Reid4-Mar-09 13:47
memberScott Reid4-Mar-09 13:47 
I have been using this .ini class for a while in my test apps that I am developing in C#. Recently I have been building web applications using Visual Studio 2008. I have this .ini class imported into my project and it all seems to work just fine when I test the app on my computer(The one that I developed the app on) but when i publish it to the remote web server, the class does not seem to work, it does not even give me an error. are there any changes i need to make to get it to read and write an .ini file on the server that is hosting the applicaiton?

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.

| Advertise | Privacy | Terms of Use | Mobile
Web02 | 2.8.150520.1 | Last Updated 15 Mar 2002
Article Copyright 2002 by BLaZiNiX
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid